Skip to content

Tools Reference

The xQR MCP server exposes 27 tools across 6 domains. Each tool maps to a v1 API endpoint.

Create a new short link.

ParameterTypeRequiredDescription
destinationURLYesThe target URL
custom_slugstringNoCustom short code
labelsstring[]NoTags for organization

List all short links in the workspace.

ParameterTypeRequiredDescription
labelstringNoFilter by label
limitnumberNoMax results (default 50)

Get details of a specific link.

ParameterTypeRequiredDescription
link_idstringYesLink UUID

Update an existing link.

ParameterTypeRequiredDescription
link_idstringYesLink UUID
destinationURLNoNew target URL
labelsstring[]NoUpdated labels
enabledbooleanNoEnable or disable

Delete a short link.

ParameterTypeRequiredDescription
link_idstringYesLink UUID

Create up to 100 links at once.

ParameterTypeRequiredDescription
linksobject[]YesArray of { destination, custom_slug?, labels? } (max 100)

Generate a QR code image for a link.

ParameterTypeRequiredDescription
link_idstringYesLink UUID
sizenumberNoSize 1-50 (default 10)

QR Codes (4 tools)

generate_qr

Generate a QR code from arbitrary content.

ParameterTypeRequiredDescription
contentstringYesText or URL to encode
sizenumberNoSize 1-50 (default 10)
formatstringNopng or svg (default svg)
error_correctionstringNoL, M, Q, or H
foregroundstringNoHex color (e.g. #000000)
backgroundstringNoHex color (e.g. #FFFFFF)

list_qr_templates

List all saved QR design templates.

No parameters.

create_qr_template

Create a new QR design template.

ParameterTypeRequiredDescription
namestringYesTemplate name
descriptionstringNoTemplate description
designobjectNo{ foreground?, background?, error_correction?, logo_url?, dot_style?, corner_style? }

render_qr_template

Render a QR code using a saved template’s design.

ParameterTypeRequiredDescription
template_idstringYesTemplate UUID
contentstringYesText or URL to encode
sizenumberNoSize 1-50 (default 10)

Analytics (6 tools)

analytics_summary

Get workspace-wide KPI summary.

ParameterTypeRequiredDescription
periodstringNo7d, 30d, 90d, or all (default 30d)

Get detailed stats for a specific link.

ParameterTypeRequiredDescription
link_idstringYesLink UUID
periodstringNoTime period

analytics_timeseries

Get scan count over time.

ParameterTypeRequiredDescription
periodstringNo7d, 30d, or 90d
granularitystringNohour or day
link_idstringNoFilter to specific link

analytics_geography

Get scans broken down by country.

ParameterTypeRequiredDescription
periodstringNoTime period
link_idstringNoFilter to specific link

analytics_devices

Get scans broken down by device type.

ParameterTypeRequiredDescription
periodstringNoTime period
link_idstringNoFilter to specific link

Get top performing links by scan count.

ParameterTypeRequiredDescription
periodstringNoTime period
limitnumberNoMax results (default 20)

list_bio_pages

List all bio pages in the workspace.

No parameters.

get_bio_page

Get details of a specific bio page.

ParameterTypeRequiredDescription
page_idstringYesPage UUID

create_bio_page

Create a new bio page.

ParameterTypeRequiredDescription
titlestringYesPage title
slugstringNoCustom URL slug
biostringNoBio text
linksobject[]NoArray of { title, url, icon? }

update_bio_page

Update an existing bio page.

ParameterTypeRequiredDescription
page_idstringYesPage UUID
titlestringNoNew title
biostringNoNew bio text
linksobject[]NoUpdated links array

publish_bio_page

Publish or unpublish a bio page.

ParameterTypeRequiredDescription
page_idstringYesPage UUID
publishbooleanYestrue to publish, false to unpublish

Assets (4 tools)

list_assets

List all assets in the workspace.

ParameterTypeRequiredDescription
limitnumberNoMax results (default 50)

get_asset

Get details of a specific asset.

ParameterTypeRequiredDescription
asset_idstringYesAsset UUID

publish_asset

Publish an asset to the CDN.

ParameterTypeRequiredDescription
asset_idstringYesAsset UUID

delete_asset

Delete an asset.

ParameterTypeRequiredDescription
asset_idstringYesAsset UUID

Workspace (3 tools)

get_workspace

Get workspace details (name, plan, owner).

No parameters.

get_workspace_usage

Get current resource usage and plan limits.

No parameters.

list_workspace_members

List all workspace members.

No parameters.

Was this page helpful?