- CodeQR Typescript MCP Server
CodeQR Typescript MCP Server
CodeQR TypeScript MCP Server
Overview
What is the CodeQR TypeScript MCP Server?
The CodeQR TypeScript MCP Server is an open-source server built with TypeScript that integrates seamlessly with the CodeQR API.
It allows developers to dynamically access and manage short links, QR codes, analytics, tags, domains, projects, and tracking events directly from any MCP-compatible client.
Installation
Direct invocation
Run the MCP server directly via npx:
export CODEQR_API_KEY="My API Key"
npx -y @codeqr/ts-mcp@latest
Via MCP Client
If you already use an MCP client, add the following JSON to your client configuration:
{
"mcpServers": {
"codeqr_ts_api": {
"command": "npx",
"args": ["-y", "@codeqr/ts-mcp", "--client=claude", "--tools=dynamic"],
"env": {
"CODEQR_API_KEY": "My API Key"
}
}
}
}
How to use the CodeQR MCP Server?
- Launch it with npx or via MCP client config
- Set your
CODEQR_API_KEYenvironment variable - Choose whether to expose all endpoints or use dynamic tools
- Filter available tools by resource, operation type (read/write), or tags
Key Features
- Links: create, update, list, delete, bulk operations, and upsert
- QR Codes: generate, update, list, delete, bulk operations, and upsert
- Analytics: retrieve performance data for links, domains, and workspaces
- Tags & Domains: organize and manage resources programmatically
- Projects: retrieve and list workspace projects
- Tracking: record leads and sales for short links
- Dynamic Tools: discover, explore, and invoke endpoints at runtime
Use Cases
- Automating short link and QR code creation inside workflows
- Retrieving analytics to monitor marketing and campaign performance
- Managing multiple domains, tags, and projects from code or AI agents
- Extending AI-driven workflows (Claude, Cursor, OpenAI Agents, etc.) with CodeQR tools
FAQ
What do I need to set up the CodeQR MCP Server? A valid CodeQR API Key from your CodeQR account.
Can it be integrated with multiple MCP clients? Yes. It supports Claude, Cursor, OpenAI Agents, and other MCP clients.
Does it support dynamic endpoint discovery?
Yes. Using --tools=dynamic, you can discover and invoke any API endpoint dynamically.
Can I filter endpoints? Yes. Filters can be applied by tool, resource, operation type, or tags.
Available Tools
Links
create_links(write): Create a new linkupdate_links(write): Update a linklist_links(read): List linksdelete_links(write): Delete a linkcount_links(read): Count linksretrieve_info_links(read): Get link detailsupsert_links(write): Upsert link by URLcreate_links_bulk(write): Bulk create linksdelete_links_bulk(write): Bulk delete links
QR Codes
create_qrcodes(write): Create a new QR Codeupdate_qrcodes(write): Update a QR Codelist_qrcodes(read): List QR Codesdelete_qrcodes(write): Delete a QR Codecount_qrcodes(read): Count QR Codesretrieve_qrcodes(read): Get QR Code detailsupsert_qrcodes(write): Upsert QR Code by URLcreate_qrcodes_bulk(write): Bulk create QR Codesdelete_qrcodes_bulk(write): Bulk delete QR Codes
Analytics
retrieve_analytics(read): Retrieve analytics for a link, domain, or workspace
Events
list_events(read): List workspace events
Tags
create_tags(write): Create a tagupdate_tags(write): Update a taglist_tags(read): List tagsdelete_tags(write): Delete a tag
Domains
create_domains(write): Create a domainupdate_domains(write): Update a domainlist_domains(read): List domainsdelete_domains(write): Delete a domain
Projects
retrieve_projects(read): Retrieve a projectlist_projects(read): List projects
Tracking
track_lead_track(write): Track a lead for a short linktrack_sale_track(write): Track a sale for a short link
Learn More
Server Config
{
"mcpServers": {
"codeqr_ts_api": {
"command": "npx",
"args": [
"-y",
"@codeqr/ts-mcp",
"--client=claude",
"--tools=dynamic"
],
"env": {
"CODEQR_API_KEY": "My API Key"
}
}
}
}