@roadmapperai/mcp 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/AGENTS.md +885 -0
  2. package/README.md +111 -0
  3. package/package.json +35 -0
  4. package/server.mjs +4019 -0
package/README.md ADDED
@@ -0,0 +1,111 @@
1
+ # @roadmapperai/mcp
2
+
3
+ The MCP (Model Context Protocol) server for [Roadmapper AI](https://roadmapperai.com).
4
+
5
+ Lets your coding agent (Claude Code, Claude Desktop, Cursor, etc.) read your
6
+ roadmap and — once write auth is enabled — propose themes, capabilities, and
7
+ tasks against your live rubric.
8
+
9
+ ## Install
10
+
11
+ You need a Roadmapper AI workspace. Sign up free at
12
+ [dashboard.roadmapperai.com](https://dashboard.roadmapperai.com).
13
+
14
+ Then add the server to your MCP client. The dashboard's Settings →
15
+ **Connect to your agent** page generates a copy-pasteable config block with
16
+ your workspace ID pre-filled — that's the fastest path.
17
+
18
+ ### Manual config
19
+
20
+ If you'd rather wire it up by hand:
21
+
22
+ #### Claude Code / Claude Desktop
23
+
24
+ Add to your `~/.config/claude-code/config.json` (or the equivalent
25
+ `claude_desktop_config.json` for the desktop app):
26
+
27
+ ```json
28
+ {
29
+ "mcpServers": {
30
+ "roadmapper": {
31
+ "command": "npx",
32
+ "args": ["-y", "@roadmapperai/mcp"],
33
+ "env": {
34
+ "SUPABASE_URL": "https://tqfhcpoblluegsbkcaqq.supabase.co",
35
+ "SUPABASE_PUBLISHABLE_KEY": "sb_publishable_oT9...",
36
+ "SUPABASE_WORKSPACE_ID": "<your workspace id>"
37
+ }
38
+ }
39
+ }
40
+ }
41
+ ```
42
+
43
+ Get your workspace ID from the dashboard's URL bar
44
+ (`dashboard.roadmapperai.com/settings` → workspace section) or from the
45
+ generated config block in Settings → Connect.
46
+
47
+ #### Cursor
48
+
49
+ Cursor's MCP settings live under **Settings → Features → MCP**. The same
50
+ JSON config works, dropped into Cursor's `mcp` field.
51
+
52
+ ## What this server exposes
53
+
54
+ Read tools (always available):
55
+
56
+ - `list_themes` — top-level strategic themes
57
+ - `list_capabilities` — capabilities (optionally filtered by theme)
58
+ - `list_tasks` — tasks (optionally filtered by capability or status)
59
+ - `get_task` — full task detail including acceptance criteria + deps
60
+ - `get_agents_md` — the planning rubric (the contract for proposals)
61
+ - `get_roadmap_snapshot` — current state of the whole roadmap
62
+ - `suggest_capability_for` — find existing capability that matches a description
63
+ - `suggest_theme_for` — find existing theme that matches a description
64
+ - `list_stale_outcomes` — capabilities whose outcome metric hasn't been
65
+ re-read recently
66
+
67
+ Write tools (require workspace-scoped write auth — coming in v0.2):
68
+
69
+ - `propose_theme`, `propose_capability`, `propose_task` — file new work
70
+ - `update_theme`, `update_capability`, `update_task` — patch existing rows
71
+ - `archive_*` / `unarchive_*` — soft delete
72
+ - `move_task`, `move_capability` — reparent
73
+ - `link_pr` — attach a merged PR to a task
74
+ - `record_outcome_reading` — log an outcome metric measurement
75
+ - `submit_acceptance_grades` — self-grade after delivery
76
+
77
+ ## How agents are meant to use this
78
+
79
+ The intended loop:
80
+
81
+ 1. Agent calls `get_agents_md` to load the rubric.
82
+ 2. Agent reads the current roadmap state via `list_themes` /
83
+ `list_capabilities` / `list_tasks`.
84
+ 3. Before proposing anything new, agent calls `suggest_capability_for`
85
+ (or `suggest_theme_for`) to check if a matching parent already exists.
86
+ 4. Agent proposes new rows through the `propose_*` tools, including all
87
+ the rubric-required fields (RICE, acceptance criteria, etc.).
88
+ 5. Once a PR is merged, the agent calls `link_pr` to attach it; the
89
+ roadmap delivery stats update automatically.
90
+ 6. After delivery, the agent self-grades against the acceptance criteria
91
+ with `submit_acceptance_grades`.
92
+
93
+ The server enforces the rubric: proposals filed without first fetching
94
+ `get_agents_md` are rejected with a remediation hint pointing the agent
95
+ back to the rubric.
96
+
97
+ ## Versioning
98
+
99
+ This package follows semver. Breaking changes to tool shapes get a
100
+ major-version bump and a deprecation window. Add `--package=@roadmapperai/mcp@0.x.y`
101
+ to your `npx` invocation if you want to pin.
102
+
103
+ ## Support
104
+
105
+ - Bugs / feature requests: contact@roadmapperai.com
106
+ - Dashboard: https://dashboard.roadmapperai.com
107
+ - Docs: https://roadmapperai.com
108
+
109
+ ## License
110
+
111
+ MIT.
package/package.json ADDED
@@ -0,0 +1,35 @@
1
+ {
2
+ "name": "@roadmapperai/mcp",
3
+ "version": "0.1.0",
4
+ "description": "Roadmapper AI MCP server — exposes a planning surface (themes, capabilities, tasks, sprints, PRs) to coding agents via stdio JSON-RPC. Pairs with the Roadmapper AI workspace at dashboard.roadmapperai.com.",
5
+ "keywords": [
6
+ "mcp",
7
+ "model-context-protocol",
8
+ "roadmap",
9
+ "planning",
10
+ "agents",
11
+ "claude",
12
+ "cursor",
13
+ "ai"
14
+ ],
15
+ "homepage": "https://roadmapperai.com",
16
+ "bugs": "mailto:contact@roadmapperai.com",
17
+ "license": "MIT",
18
+ "author": "Roadmapper AI",
19
+ "type": "module",
20
+ "main": "server.mjs",
21
+ "bin": {
22
+ "roadmapper-mcp": "server.mjs"
23
+ },
24
+ "files": [
25
+ "server.mjs",
26
+ "AGENTS.md",
27
+ "README.md"
28
+ ],
29
+ "engines": {
30
+ "node": ">=18.17"
31
+ },
32
+ "scripts": {
33
+ "prepack": "cp ../AGENTS.md ./AGENTS.md"
34
+ }
35
+ }