Tools Reference
The xQR MCP server exposes 27 tools across 6 domains. Each tool maps to a v1 API endpoint.
Links (7 tools)
create_link
Create a new short link.
| Parameter | Type | Required | Description |
|---|---|---|---|
destination | URL | Yes | The target URL |
custom_slug | string | No | Custom short code |
labels | string[] | No | Tags for organization |
list_links
List all short links in the workspace.
| Parameter | Type | Required | Description |
|---|---|---|---|
label | string | No | Filter by label |
limit | number | No | Max results (default 50) |
get_link
Get details of a specific link.
| Parameter | Type | Required | Description |
|---|---|---|---|
link_id | string | Yes | Link UUID |
update_link
Update an existing link.
| Parameter | Type | Required | Description |
|---|---|---|---|
link_id | string | Yes | Link UUID |
destination | URL | No | New target URL |
labels | string[] | No | Updated labels |
enabled | boolean | No | Enable or disable |
delete_link
Delete a short link.
| Parameter | Type | Required | Description |
|---|---|---|---|
link_id | string | Yes | Link UUID |
bulk_create_links
Create up to 100 links at once.
| Parameter | Type | Required | Description |
|---|---|---|---|
links | object[] | Yes | Array of { destination, custom_slug?, labels? } (max 100) |
get_link_qr
Generate a QR code image for a link.
| Parameter | Type | Required | Description |
|---|---|---|---|
link_id | string | Yes | Link UUID |
size | number | No | Size 1-50 (default 10) |
QR Codes (4 tools)
generate_qr
Generate a QR code from arbitrary content.
| Parameter | Type | Required | Description |
|---|---|---|---|
content | string | Yes | Text or URL to encode |
size | number | No | Size 1-50 (default 10) |
format | string | No | png or svg (default svg) |
error_correction | string | No | L, M, Q, or H |
foreground | string | No | Hex color (e.g. #000000) |
background | string | No | Hex color (e.g. #FFFFFF) |
list_qr_templates
List all saved QR design templates.
No parameters.
create_qr_template
Create a new QR design template.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Template name |
description | string | No | Template description |
design | object | No | { foreground?, background?, error_correction?, logo_url?, dot_style?, corner_style? } |
render_qr_template
Render a QR code using a saved template’s design.
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | Template UUID |
content | string | Yes | Text or URL to encode |
size | number | No | Size 1-50 (default 10) |
Analytics (6 tools)
analytics_summary
Get workspace-wide KPI summary.
| Parameter | Type | Required | Description |
|---|---|---|---|
period | string | No | 7d, 30d, 90d, or all (default 30d) |
analytics_link_stats
Get detailed stats for a specific link.
| Parameter | Type | Required | Description |
|---|---|---|---|
link_id | string | Yes | Link UUID |
period | string | No | Time period |
analytics_timeseries
Get scan count over time.
| Parameter | Type | Required | Description |
|---|---|---|---|
period | string | No | 7d, 30d, or 90d |
granularity | string | No | hour or day |
link_id | string | No | Filter to specific link |
analytics_geography
Get scans broken down by country.
| Parameter | Type | Required | Description |
|---|---|---|---|
period | string | No | Time period |
link_id | string | No | Filter to specific link |
analytics_devices
Get scans broken down by device type.
| Parameter | Type | Required | Description |
|---|---|---|---|
period | string | No | Time period |
link_id | string | No | Filter to specific link |
analytics_top_links
Get top performing links by scan count.
| Parameter | Type | Required | Description |
|---|---|---|---|
period | string | No | Time period |
limit | number | No | Max results (default 20) |
Link-in-Bio (5 tools)
list_bio_pages
List all bio pages in the workspace.
No parameters.
get_bio_page
Get details of a specific bio page.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id | string | Yes | Page UUID |
create_bio_page
Create a new bio page.
| Parameter | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Page title |
slug | string | No | Custom URL slug |
bio | string | No | Bio text |
links | object[] | No | Array of { title, url, icon? } |
update_bio_page
Update an existing bio page.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id | string | Yes | Page UUID |
title | string | No | New title |
bio | string | No | New bio text |
links | object[] | No | Updated links array |
publish_bio_page
Publish or unpublish a bio page.
| Parameter | Type | Required | Description |
|---|---|---|---|
page_id | string | Yes | Page UUID |
publish | boolean | Yes | true to publish, false to unpublish |
Assets (4 tools)
list_assets
List all assets in the workspace.
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | No | Max results (default 50) |
get_asset
Get details of a specific asset.
| Parameter | Type | Required | Description |
|---|---|---|---|
asset_id | string | Yes | Asset UUID |
publish_asset
Publish an asset to the CDN.
| Parameter | Type | Required | Description |
|---|---|---|---|
asset_id | string | Yes | Asset UUID |
delete_asset
Delete an asset.
| Parameter | Type | Required | Description |
|---|---|---|---|
asset_id | string | Yes | Asset 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?
Thanks for your feedback!