Skip to main content
The three Analytics tools are added in the Node.js 0.7.0 / Python 0.4.0 source release. Remote deployment and npm/PyPI publication are separate steps. Check your endpoint’s tools/list for availability.
Connect directly to Remote MCP (Streamable HTTP) to use all 32 tools. A local stdio proxy is also available, but its tools and parameters depend on the package and version. Check MCP tools/list for the actual catalog.

Prerequisites

  • One of the supported clients: Cursor, Claude Code, or Codex
  • A Shanone account and an API key from Settings → API Keys (starts with sh_)
  • Node.js 18+ if using the local proxy

Step 1: Get your API key

1

Sign in

Go to app.shanone.ai and sign in.
2

Open API Keys

Go to Settings → API Keys.
3

Create a key

Click Create API Key, name it, and choose an expiration (30 days by default). You can also choose 7, 60, or 90 days, Custom (1–366 days), or Never. Create the key and copy the plaintext value — shown only once, in the form sh_xxxxxxxxxxxxxxxx. See Expiration for lifetime and renewal details.
Treat your API key like a password. Never commit it to version control or share it publicly.

Step 2: Configure your client

For an HTTP-capable client, configure the following URL and headers. The Cursor direct HTTP tab shows a complete example; the other tabs include proxy configurations for stdio clients.
Edit ~/.cursor/mcp.json (or use Cursor Settings → MCP to add a server):
Restart Cursor to load the MCP server.
Replace every placeholder key/org ID above with your actual values.

Plans and connection checks

  • Remote Skills require Plus / Pro / Team / Enterprise. Free users still see the tools, but execution returns PLAN_UPGRADE_REQUIRED.
  • shanone_health_check verifies connectivity to Shanone. Use shanone_check_connection to verify provider authentication such as Gmail.
  • Gmail execution requires a connection_id from shanone_list_connections. Supply it when you receive CONNECTION_SELECTION_REQUIRED.
  • shanone_create_execution_context, shanone_get_execution_context, and shanone_switch_connection have been removed. Refresh your client’s tool list.
  • Updated implementations accept shanone_execute_tool.arguments as an object; use {} for no arguments. Reconnect to refresh tools/list and check version and rollout compatibility.

Python proxy (alternative)

A Python package is also available for Python-centric environments:

Verify the connection

1

Open your client's AI chat

Any MCP-connected chat interface.
2

Ask for a health check

“Check Shanone connection status.”
3

Confirm the result

shanone_health_check should report a healthy status with your API key valid and the database reachable.

Configuration reference

Troubleshooting

No API key was sent. Double-check your config’s env/headers block matches exactly what’s shown above.
The key is missing, malformed, revoked, or expired. Check its status and expiration in Settings → API Keys. For an expired or revoked key, create a new one and update your client configuration; the old key cannot be reactivated. See Expiration.
You’re using the direct /mcp endpoint without (or with the wrong) X-Org-Id. Copy the exact organization ID from Settings → API Keys, or switch to the local proxy, which doesn’t need it.
You’ve exceeded your key’s rate limit. Wait for the duration in the Retry-After header, or ask an admin to raise the limit.
  1. Fully restart your client after editing the config.
  2. Check for JSON/TOML syntax errors.
  3. Confirm the server name in the config matches what you reference (usually shanone).
  4. If using the local proxy, run npx -y @duzzle/shanone-mcp directly in a terminal to see startup errors.

Security best practices

1

Use environment variables

Where your client supports it, reference an environment variable instead of hardcoding the key in a committed config file.
2

Name keys per machine/agent

So you can revoke one without affecting others.
3

Rotate periodically

Before a key expires, create a new one from Settings → API Keys, update your client configuration, and confirm it works before revoking the old key.

Next Steps

Shanone MCP Server

Available tools and use cases

Tools Reference

Parameters, plans, and billing for all 32 Remote MCP tools