MCP Server Setup Guide
What is the Commish MCP Server?
The Commish MCP (Model Context Protocol) server lets you manage your entire commission tracking workflow through natural language. Instead of clicking through the dashboard, just tell your AI assistant what you need:
- *"Show me all pending deals"*
- *"What would Sarah earn if she closes a $150K deal?"*
- *"Create a Q3 SPIFF — $500 per new logo over $10K"*
- *"Clone Phil's comp plan and bump accelerators by 2%"*
It works with Claude Desktop, Claude Code, ChatGPT, Cursor, and any MCP-compatible AI client.
Prerequisites
- Node.js 18+ installed on your machine
- A Commish account with API access enabled
- An MCP-compatible AI client
Step 1: Generate Your API Key
- Log in to Commish at app.getcommish.io
- Navigate to Admin → Settings → API Keys
- Click "Create API Key"
- Name your key (e.g., "Claude Desktop MCP") and select scopes:
| Scope | Permissions |
|---|---|
read | View deals, comp plans, commissions, SPIFFs, users |
write | Create and update deals |
admin | All of the above + approve deals, manage comp plans, SPIFFs, webhooks, users |
- Copy your key. It will look like:
cm_live_a1b2c3d4e5f6...
⚠️ Important: Store your API key securely. It provides direct access to your commission data. Never share it publicly or commit it to version control.
Step 2: Configure Your AI Client
Claude Desktop (macOS)
Edit ~/Library/Application Support/Claude/claude_desktop_config.json:
`json
{
"mcpServers": {
"commish": {
"command": "npx",
"args": ["-y", "commish-mcp-server"],
"env": {
"COMMISH_API_KEY": "cm_live_your_api_key_here"
}
}
}
}
`
Claude Desktop (Windows)
Edit %APPDATA%\Claude\claude_desktop_config.json with the same configuration as above.
Claude Code
`bash
# Add the MCP server
claude mcp add commish -- npx -y commish-mcp-server
# Set your API key in your environment
export COMMISH_API_KEY="cm_live_your_api_key_here"
`
Cursor
Create or edit .cursor/mcp.json in your project root:
`json
{
"mcpServers": {
"commish": {
"command": "npx",
"args": ["-y", "commish-mcp-server"],
"env": {
"COMMISH_API_KEY": "cm_live_your_api_key_here"
}
}
}
}
`
Local Development (from source)
`bash
git clone https://github.com/commish-io/commish-mcp-server
cd commish-mcp-server
npm install
npm run build
COMMISH_API_KEY="cm_test_your_key" node dist/index.js
`
Step 3: Verify the Connection
After configuring, restart your AI client. You should see 28 Commish tools available. Try a simple command:
Try it: "List all my sales reps" — this should return your team from Commish.
Available Tools (28 Total)
Deals (6 tools)
| Tool | Description | Scope |
|---|---|---|
list_deals | List and filter deals by status, rep, date | read |
get_deal | Get full deal details | read |
create_deal | Log a new deal (created as pending) | write |
update_deal | Modify deal details | write |
approve_deal | Approve a pending deal (triggers commission calc) | admin |
reject_deal | Reject a pending deal | admin |
Comp Plans (6 tools)
| Tool | Description | Scope |
|---|---|---|
list_comp_plans | List all compensation plans | read |
get_comp_plan | Get full plan details with tiers & accelerators | read |
create_comp_plan | Create a new comp plan | admin |
update_comp_plan | Modify plan rates, tiers, caps | admin |
assign_comp_plan | Assign a plan to one or more reps | admin |
clone_comp_plan | Duplicate a plan as a starting point | admin |
Users (5 tools)
| Tool | Description | Scope |
|---|---|---|
list_users | List all reps and team members | read |
get_user | Get user details and plan info | read |
get_user_commissions | Get a rep's commission history | read |
create_user | Add a new rep to the org | admin |
update_user | Update rep details or status | admin |
Commissions (3 tools)
| Tool | Description | Scope |
|---|---|---|
list_commissions | Org-wide commission records | read |
get_commission_summary | Aggregated totals, by-rep & by-period breakdowns | read |
simulate_commission | What-if calculator for hypothetical deals | read |
SPIFFs (5 tools)
| Tool | Description | Scope |
|---|---|---|
list_spiffs | List all SPIFF programs | read |
get_spiff | SPIFF details + live leaderboard | read |
create_spiff | Create a new SPIFF/contest | admin |
update_spiff | Modify a running or draft SPIFF | admin |
delete_spiff | Cancel/delete a SPIFF | admin |
Webhooks (3 tools)
| Tool | Description | Scope |
|---|---|---|
list_webhooks | List webhook subscriptions | admin |
create_webhook | Subscribe to deal/commission/SPIFF events | admin |
delete_webhook | Remove a subscription | admin |
Example Conversations
| You Say | What Happens |
|---|---|
| "Show me all pending deals" | Lists deals filtered by pending status |
| "Log a new deal — Acme Corp, $85K ARR, new business" | Creates a deal in pending status |
| "Approve deal abc-123" | Approves the deal and triggers commission calculation |
| "How much has Phil earned this year?" | Looks up Phil, then pulls his commission history |
| "What's our total commission payout?" | Returns org-wide commission summary |
| "What would Sarah earn on a $150K new biz deal?" | Runs the commission simulator with her comp plan |
| "Create a comp plan — 10% new biz, 5% renewals, $250K quarterly quota" | Creates a full comp plan with rates and quota |
| "Set up a Q3 SPIFF — $500 per new logo over $10K, capped at 5 per rep" | Creates a SPIFF with criteria and caps |
| "Clone Phil's plan and assign it to the East team" | Clones the plan, then assigns to multiple reps |
Environment Variables
| Variable | Required | Description |
|---|---|---|
COMMISH_API_KEY | Yes | Your API key (starts with cm_live_ or cm_test_) |
COMMISH_API_URL | No | Override API base URL (default: https://app.getcommish.io/api/v1) |
Rate Limits
The Commish API allows 100 requests per minute per API key. The MCP server automatically retries with exponential backoff if you hit the limit. Under normal conversational use, you'll never come close to this limit.
Troubleshooting
"Authentication failed"
- Verify your
COMMISH_API_KEYis set correctly in your client config - Check that the key starts with
cm_live_orcm_test_ - Confirm the key hasn't been revoked in Admin → Settings → API Keys
"Insufficient scope"
- Your API key doesn't have the required permission for that action
- Write operations need
writescope; management actions needadmin - Generate a new key with broader scopes if needed
"No tools showing in my AI client"
- Restart your AI client after editing the config file
- Verify the JSON config is valid (no trailing commas, proper quotes)
- Check that
npxis available in your PATH - Try running manually:
COMMISH_API_KEY=your_key npx -y commish-mcp-server
Security Best Practices
- Use test keys (
cm_test_) during development and evaluation - Use the minimum scope needed — if you only need to view data, use
read - Rotate keys periodically via Admin → Settings → API Keys
- Never commit API keys to version control — use environment variables
- Set key expiration dates for temporary integrations
Was this article helpful?