Configuration
Environment Variables
| Variable | Required | Default | Description |
|---|---|---|---|
XQR_API_KEY | Yes | — | Your xQR API key (Pro plan or higher) |
XQR_API_URL | No | https://xqr.co/api/v1 | Base URL for the xQR v1 API |
XQR_API_KEY
The API key used to authenticate all requests. Generate one at platform.xqr.co/dashboard/developers.
The key’s scopes determine which MCP tools are available. For full access, create a key with the * (wildcard) scope.
XQR_API_URL
Override the API base URL. Useful for:
- Local development: Point to
http://localhost:8080/api/v1 - Staging environments: Point to your staging API
- Self-hosted instances: Point to your own xQR deployment
Scope Requirements
Each MCP tool requires specific API key scopes:
| Tool Group | Required Scopes |
|---|---|
| Link tools | links:read, links:write |
| QR tools | qr:read, qr:write, qr:render |
| Analytics tools | analytics:read |
| Bio tools | bio:read, bio:write |
| Asset tools | assets:read, assets:write |
| Workspace tools | workspace:read |
If a tool is called without the required scope, it returns an error message explaining which scope is needed.
Transport
The MCP server currently supports stdio transport only. It communicates via stdin/stdout with the parent process (your AI client).
A future release will add Streamable HTTP transport for remote server deployment.
Was this page helpful?
Thanks for your feedback!