mcp
Setup Guide
Get Clarity MCP running in Claude Desktop, Cursor, or any MCP-compatible client in under 2 minutes.
Prerequisites
- A Clarity account with at least one project
- An MCP-compatible AI client (Claude Desktop, Cursor, Windsurf, etc.)
The setup wizard below will generate a ready-to-paste config snippet for your client. Just paste your API key and copy the config.
1Get your API key
Generate an API key in your Clarity settings. You'll paste it into the config below.
Create API key in Settings2Configure your client
Config file location:
macOS
~/Library/Application Support/Claude/claude_desktop_config.jsonWin
%APPDATA%\Claude\claude_desktop_config.jsonjson
{
"mcpServers": {
"clarity": {
"command": "npx",
"args": [
"-y",
"clarity-mcp@latest"
],
"env": {
"CLARITY_API_KEY": "<your-api-key>",
"CLARITY_API_URL": "https://www.claritynotes.xyz"
}
}
}
}- 1Open Claude Desktop → Settings → Developer → Edit Config
- 2Paste the config below into
claude_desktop_config.json - 3Replace
<your-api-key>with the key you copied - 4Save the file and restart Claude Desktop
3Verify the connection
Ask your AI assistant:
“List my Clarity projects”
If configured correctly, it will call the list_projects tool and return your workspace.
Troubleshooting
| Problem | Solution |
|---|---|
| "CLARITY_API_KEY is required" | Make sure the env block includes your key |
| "API 401: Invalid API key" | Regenerate the key in Settings → MCP / API |
| Tools not showing up | Restart your AI client after editing the config |
You can test the connection by asking your AI: "List my Clarity projects." If it returns your workspace, everything is working.
Was this helpful?
