@planetroadmap/mcp
v0.1.0
Published
Model Context Protocol server for PlanetRoadmap — let Claude read and update your tasks, projects, and feedback.
Downloads
56
Maintainers
Readme
@planetroadmap/mcp
Model Context Protocol server for PlanetRoadmap. Lets Claude Code (and any other MCP-compatible client) read and update your tasks, projects, feature requests, comments, and OKRs through your PlanetRoadmap API key.
Install
# Most users don't install — they reference it via npx in their MCP config (see below).
# But if you want a global CLI:
npm install -g @planetroadmap/mcpSetup
1. Generate an API key
In PlanetRoadmap, go to Settings → Integrations for your org and create an API key. Grant the scopes you want Claude to have. A reasonable default is:
tasks:read,tasks:writeprojects:readrequests:read,requests:writecomments:read,comments:writeokrs:read,okrs:write
API access requires a Pro or Enterprise plan.
2. Add to your MCP config
For Claude Code, edit ~/.claude/mcp.json (or your project's .claude/mcp.json):
{
"mcpServers": {
"planetroadmap": {
"command": "npx",
"args": ["-y", "@planetroadmap/mcp"],
"env": {
"PLANETROADMAP_API_KEY": "pk_live_...",
"PLANETROADMAP_ORG_SLUG": "your-org-slug"
}
}
}
}For other clients (Claude Desktop, Cursor, etc.), use the equivalent stdio-server config block.
3. (Optional) Install the skill
The package ships a Claude skill in skill/SKILL.md that teaches Claude domain conventions: terminology (task vs feature request vs portal), common workflows, and what fields are public. Drop it into your skills directory:
mkdir -p ~/.claude/skills/planetroadmap
cp node_modules/@planetroadmap/mcp/skill/SKILL.md ~/.claude/skills/planetroadmap/Environment variables
| Variable | Required | Default | Notes |
|---|---|---|---|
| PLANETROADMAP_API_KEY | yes | — | pk_live_... from Settings → Integrations |
| PLANETROADMAP_ORG_SLUG | yes | — | The slug in your dashboard URLs |
| PLANETROADMAP_BASE_URL | no | https://planetroadmap.com | Override for self-hosted or staging |
Tools
| Tool | What it does |
|---|---|
| whoami | Verify the API key, return org and granted permissions |
| list_tasks | Filter tasks by status, project, assignee, search, since |
| get_task | Full details of one task |
| create_task | Create a task (resolves assignee by email) |
| update_task | Patch any subset of task fields |
| delete_task | Hard delete (prefer status=done instead) |
| list_projects | Filter projects by status, search |
| get_project | Project detail with task count |
| list_feature_requests | Customer feedback, filter by status, search, votes |
| get_feature_request | One feature request |
| create_feature_request | Log feedback into a portal |
| update_feature_request | Triage — change status, add public statusNote, move portals |
| list_comments | Comments on feature requests |
| add_comment | Post a (public, official by default) reply |
| list_okrs | Objectives with key results and computed progress |
| update_key_result_progress | Bump currentValue on a key result |
All tools route through https://planetroadmap.com/api/v1/{orgSlug}/.... Rate limit is 100 requests/minute per API key.
Local development
npm install
npm run build # tsc → dist/
npm run smoke # spawn the server, list tools, verify error path
node dist/index.js # run it directly (needs env vars set)License
MIT
