> ## Documentation Index > Fetch the complete documentation index at: https://docs.codeqr.io/llms.txt > Use this file to discover all available pages before exploring further. # Tool reference > The fourteen tools the CodeQR MCP server exposes, and what each one accepts. Every tool is annotated so your client knows what it does before it runs. Four of them change something already in circulation, and a well-behaved client will ask you to confirm those. | | Meaning | | ------------------ | ---------------------------------------------------------------- | | **Read** | Reads only. Changes nothing. | | **Creates** | Creates something publicly reachable. Overwrites nothing. | | **Overwrites** | Changes or removes something already shared or printed. | | **Workspace only** | Writes private workspace state. Nothing on the open web changes. | ## Links **Creates.** Create a trackable short link. The link is a live endpoint: it keeps resolving after the conversation ends, and its destination can be changed later with `update_link`. The destination URL to shorten. Custom domain. Custom slug. Auto-generated if omitted. Your own reference ID for the link. Tag IDs to associate. Internal notes. Expiration date, ISO 8601. Password-protect the link. **Read.** List all short links in the workspace. Search keyword. Filter by domain. Filter by tag ID. Page number. **Read.** Details for one short link. Identify it by `linkId`, by `externalId`, or by `domain` and `key` together — for `codeqr.link/github`, that is domain `codeqr.link` and key `github`. At least one is required. The link ID, as returned by `list_links`. Your own ID for the link, if you set one. The link domain. Use with `key`. The link slug. Use with `domain`. **Overwrites.** Change where an existing short link points. Anything already shared keeps working and now leads to the new destination — **unless you also change `key`**, which rewrites the link itself and breaks every copy already in circulation. The link ID to update. New destination URL. New slug. Breaks existing copies. Archive status. New expiration date. Updated comments. **Overwrites.** Delete a short link. Anything already shared stops resolving. The link ID to delete. ## QR codes **Creates.** Create a dynamic QR code. The printed pattern encodes a short link rather than the content itself, so what it leads to can be changed later without reprinting, and every scan is recorded. Pass the payload field matching the `type` you choose. `url` · `text` · `email` · `phone` · `sms` · `wifi` · `vcard` · `crypto` · `whatsapp`. Defaults to `url`. For type `url`: the destination the code should lead to. For type `text`: the plain text to encode. For type `phone`: the number to call, e.g. `+5511999999999`. For type `email`: the message a scan should open. For type `sms`: the message a scan should compose. For type `wifi`: the network a scan should join. For type `vcard`: the contact card a scan should offer to save. City, state, zipcode and country are only encoded when `address` is also given. For type `crypto`: the payment request a scan should open. For type `whatsapp`: the conversation a scan should open. Three sub-fields are named in a way nobody guesses, and a wrong key saves without error and encodes nothing: the recipient in `crypto` is **`address`**, the blind-copy field in `email` is **`cco`**, and `sms` carries a **`subject`**. Domain for the underlying short link. Custom slug for the underlying short link. Size in pixels. Error correction level: `L` · `M` · `Q` · `H`. Foreground color, hex. Background color, hex. **Read.** List all QR codes in the workspace. Page number. **Overwrites.** Change what a dynamic QR code leads to without reprinting it: copies already distributed now resolve to the new content. Pass the payload field matching the type the code **already has** — `url` for a link code, `wifi` for a Wi-Fi code. A code cannot be converted from one type to another here: sending a `wifi` payload to a `url` code is accepted and silently changes nothing, so check the type with `list_qrcodes` first if you are unsure. This does not apply to **static** QR codes, which encode the content directly in the printed pattern. For those the stored record changes, but anything already printed keeps leading to the old content forever. The QR code ID to update. For a `url` code: the new destination. For a `text` code: the new plain text. For a `phone` code: the new number. For an `email` code: the new message. For an `sms` code: the new message. For a `wifi` code: the new network. For a `vcard` code: the new contact card. For a `crypto` code: the new payment request. For a `whatsapp` code: the new conversation. New foreground color, hex. New background color, hex. Archive status. **Overwrites.** Delete a QR code. Any printed copy stops resolving and cannot be recovered by reprinting. The QR code ID to delete. ## Analytics **Read.** Scan and click analytics — workspace-wide, or for one link or QR code. `clicks` · `scans` · `leads` · `sales` · `composite`. Use `scans` for QR codes and `clicks` for short links. `count` · `timeseries` · `countries` · `cities` · `devices` · `browsers` · `os` · `referers` · `top_links` · `top_qrcodes` · `top_urls`. Filter by link ID. Filter by QR code ID. Filter by domain. Filter by slug. Use with `domain`. `1h` · `24h` · `7d` · `30d` · `90d` · `ytd` · `1y` · `all`. Defaults to `24h`. How far back you can look depends on your plan, and a longer window returns `403` rather than a truncated result: **Free** stops at 30 days, **Starter** at 90 days, **Pro** at 1 year, **Business** has no limit. **`scans` is only separated from `clicks` for `count` and `timeseries`.** Every other grouping — `countries`, `cities`, `devices`, `browsers`, `os`, `referers` — reports traffic as `clicks` across links, QR codes and pages together, whichever `event` you pass. To break a QR code's scans down by country, pass its `qrcodeId` so the query is scoped to that one code; read the figure as that code's traffic. For a workspace-wide scan total, use `groupBy: count` or `groupBy: timeseries`, which do separate the three. ## Workspace **Read.** List custom domains configured in the workspace. Search keyword. Page number. Results per page. **Read.** List all tags in the workspace. Search keyword. Page number. Results per page. **Workspace only.** Create a tag for organizing links. Tag name. `red` · `yellow` · `green` · `blue` · `purple` · `pink` · `brown`. **Read.** The workspace this connection is authorized for, including its name, slug and plan. Useful before creating in bulk, or before using a feature the plan may not include. Takes no arguments. ## Not available here **Conversion tracking.** `track_lead` and `track_sale` are not exposed. They need the `conversions.write` scope, which cannot be requested without locking non-owners out of the connection entirely. Use the [API](/api-reference/introduction) for conversions.