​
Overview

MCP resources provide read-only access to data that AI assistants can use for context. Resources are accessed using URI schemes that map to your Jmpy.me data.
Resources require authentication via your MCP API key, except for public resources.

​
Available Resources

​
User Resources

These resources provide access to your data and require authentication.
​
user://profile
resource
Your authenticated user profile information.MIME Type: application/jsonReturns your account details, email, and settings.
​
user://urls
resource
List of all short URLs created by you.MIME Type: application/jsonReturns an array of short URL objects with click statistics.
​
user://qrcodes
resource
List of all QR codes created by you.MIME Type: application/jsonReturns an array of QR code objects with scan statistics.
​
user://campaigns
resource
List of all campaigns created by you.MIME Type: application/jsonReturns campaign data with associated URL counts.
​
user://domains
resource
Your custom subdomains and branded domains.MIME Type: application/jsonReturns domain configuration and verification status.
​
user://stats
resource
Overview statistics for your URLs and QR codes.MIME Type: application/jsonReturns aggregate statistics like total clicks, scans, and performance metrics.
​
user://plan
resource
Your current subscription plan and feature limits.MIME Type: application/jsonReturns plan tier, enabled features, and quota limits.
​
user://usage
resource
Your current usage against plan limits.MIME Type: application/jsonReturns current consumption vs. quota for all rate-limited features.

​
Public Resources

These resources don’t require authentication.
​
public://plans
resource
List of available subscription plans and their features.MIME Type: application/json
​
server://status
resource
MCP server health and status information.MIME Type: application/json
​
server://tools
resource
List of all available MCP tools and their schemas.MIME Type: application/json

​
Resource Templates

Resource templates allow dynamic access to specific items using URI parameters.
​
url://{shortCode}
template
Details of a specific short URL by its short code.Example: url://abc123Returns the full short URL object including original URL, click count, and settings.
​
qr://{id}
template
Details of a specific QR code by its ID.Example: qr://550e8400-e29b-41d4-a716-446655440000Returns the full QR code object including content, visual settings, and scan count.
​
campaign://{id}
template
Details of a specific campaign by its ID or name.Example: campaign://q1-marketingReturns campaign data with all associated URLs.
​
analytics://{shortCode}
template
Complete analytics for a specific short URL.Example: analytics://abc123Returns comprehensive analytics including clicks, referrers, devices, and locations.

​
Using Resources

AI assistants can read resources to gather context before performing actions.

​
Example: Getting Your URLs

When you ask an AI assistant to work with your URLs, it can first read the user://urls resource: 
User: "Which of my links got the most clicks this week?"

AI Assistant reads: user://urls
→ Gets list of all URLs with click data
→ Analyzes and responds with the top performer

​
Example: Accessing Specific URL Details

For operations on a specific URL: 
User: "Show me the analytics for my landing page link"

AI Assistant reads: url://landing-page
→ Gets the specific URL details
AI Assistant reads: analytics://landing-page
→ Gets full analytics breakdown
→ Presents the data in a clear format

​
Accessing Resources via API

Resources are accessed through the MCP protocol, but you can also access them directly via REST: 
curl -X POST https://jmpy.me/mcp \
  -H "x-mcp-key: YOUR_MCP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "resources/read",
    "params": {
      "uri": "user://urls"
    }
  }'

MCP Tools

View available MCP tools for performing actions