@pathmode/mcp-server 1.2.0 → 1.2.1

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 (2) hide show
  1. package/README.md +130 -137
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,45 +1,36 @@
1
1
  # @pathmode/mcp-server
2
2
 
3
- Connect Claude Code, Cursor, and other AI agents to your [Pathmode](https://pathmode.io) Intent Layer.
3
+ Build structured intent specs through Socratic AI conversation right in your terminal.
4
4
 
5
- Get strategic context, dependency graph analysis, and structured implementation prompts — so your AI agent builds the right thing, not just any thing.
5
+ No signup. No API key. Just add the MCP server and start talking.
6
6
 
7
- ## Features
7
+ ## Intent Compiler
8
8
 
9
- - **Intent context** Structured specs with objectives, outcomes, constraints, and edge cases
10
- - **Dependency graph analysis** — Critical path, cycle detection, bottleneck identification
11
- - **Context export** — Generate CLAUDE.md, .cursorrules, and intent.md files
12
- - **Workspace strategy** — Vision, non-negotiables, architecture principles
13
- - **Constitution rules** — Mandatory constraints for all implementations
14
- - **Implementation tracking** — Status updates and technical decision logging
9
+ The Intent Compiler turns Claude Code into a Socratic product thinking partner. Describe a problem, paste a support ticket, or explain what's broken — Claude challenges vague thinking, asks pointed questions, and builds a structured spec.
15
10
 
16
- ## Quick Start
17
-
18
- ```bash
19
- npx @pathmode/mcp-server
20
11
  ```
12
+ > Help me write an intent spec for our checkout flow
21
13
 
22
- ## Setup
14
+ What's broken about it? When you say "checkout flow" — is the whole
15
+ thing failing, or is there one specific moment where users bail?
23
16
 
24
- ### Claude Desktop
17
+ > Payment step times out and users get confused
25
18
 
26
- Add to `~/.config/Claude/claude_desktop_config.json`:
19
+ When you say "times out" — is that 5 seconds or 30? And what does
20
+ the user actually see? A spinner? A blank screen? An error?
27
21
 
28
- ```json
29
- {
30
- "mcpServers": {
31
- "pathmode": {
32
- "command": "npx",
33
- "args": ["@pathmode/mcp-server"],
34
- "env": {
35
- "PATHMODE_API_KEY": "pm_live_..."
36
- }
37
- }
38
- }
39
- }
22
+ > About 8 seconds, they see a spinner with no feedback
23
+
24
+ Proposed Objective: "Reduce cart abandonment caused by payment step
25
+ timeouts exceeding 3 seconds, where users see a spinner with no
26
+ status feedback or recovery path."
27
+
28
+ Does that capture it, or is there more to the pain?
40
29
  ```
41
30
 
42
- ### Claude Code
31
+ When the spec is ready, Claude saves it as `intent.md` and optionally exports as `.cursorrules` or `CLAUDE.md` — so every AI agent in your project sees the intent as its implementation context.
32
+
33
+ ### Quick Start
43
34
 
44
35
  Add to `.claude/settings.json`:
45
36
 
@@ -48,18 +39,79 @@ Add to `.claude/settings.json`:
48
39
  "mcpServers": {
49
40
  "pathmode": {
50
41
  "command": "npx",
51
- "args": ["@pathmode/mcp-server"],
52
- "env": {
53
- "PATHMODE_API_KEY": "pm_live_..."
54
- }
42
+ "args": ["@pathmode/mcp-server"]
55
43
  }
56
44
  }
57
45
  }
58
46
  ```
59
47
 
60
- ### Cursor
48
+ Then in Claude Code:
61
49
 
62
- Add to `.cursor/mcp.json`:
50
+ ```
51
+ > Help me write an intent spec for [your problem here]
52
+ ```
53
+
54
+ That's it. No API key needed.
55
+
56
+ ### What You Get
57
+
58
+ **intent.md** — Structured spec with YAML frontmatter:
59
+ ```markdown
60
+ ---
61
+ id: "intent_17291..."
62
+ version: 1
63
+ status: "draft"
64
+ ---
65
+ # Fix Checkout Payment Timeout
66
+
67
+ ## Objective
68
+ Reduce cart abandonment caused by payment step
69
+ timeouts exceeding 3 seconds.
70
+
71
+ ## Outcomes
72
+ - [ ] Payment completes in under 3 seconds (p95)
73
+ - [ ] Users see real-time status during processing
74
+ - [ ] Failed payments show actionable error with retry
75
+
76
+ ## Edge Cases
77
+ - **Network timeout during payment**: Show retry button, no double-charge
78
+ - **Unknown provider status**: Hold order, notify user within 30s
79
+ ```
80
+
81
+ **.cursorrules** — Agent-directive format for Cursor:
82
+ ```
83
+ # CURRENT OBJECTIVE
84
+ You are implementing: "Fix Checkout Payment Timeout"
85
+
86
+ # SUCCESS OUTCOMES
87
+ Your implementation MUST satisfy ALL of these:
88
+ - Payment completes in under 3 seconds (p95)
89
+ - Users see real-time status during processing
90
+ - Failed payments show actionable error with retry
91
+ ```
92
+
93
+ **CLAUDE.md** — Appends a `<!-- PATHMODE:START -->` section so Claude Code sees the intent in every conversation.
94
+
95
+ ### Intent Compiler Tools
96
+
97
+ | Tool | Description |
98
+ |------|-------------|
99
+ | `intent_save` | Save an intent spec to `intent.md` in the project root |
100
+ | `intent_export` | Export as `.cursorrules` or `CLAUDE.md` section |
101
+
102
+ ### Intent Compiler Prompt
103
+
104
+ | Prompt | Description |
105
+ |--------|-------------|
106
+ | `compile-intent` | Start a Socratic conversation to build an intent spec |
107
+
108
+ ---
109
+
110
+ ## Team Features (API Key Required)
111
+
112
+ For teams shipping with AI agents, connect to your [Pathmode](https://pathmode.io) workspace for dependency tracking, strategic context, and governance.
113
+
114
+ ### Setup with API Key
63
115
 
64
116
  ```json
65
117
  {
@@ -75,6 +127,10 @@ Add to `.cursor/mcp.json`:
75
127
  }
76
128
  ```
77
129
 
130
+ Works with Claude Code (`.claude/settings.json`), Claude Desktop (`claude_desktop_config.json`), and Cursor (`.cursor/mcp.json`).
131
+
132
+ Get your API key from **Settings > API Keys** in the [Pathmode app](https://pathmode.io).
133
+
78
134
  ### Local Mode (Offline)
79
135
 
80
136
  Read `intent.md` files from your project directory without an API key:
@@ -90,46 +146,45 @@ Read `intent.md` files from your project directory without an API key:
90
146
  }
91
147
  ```
92
148
 
93
- ## Configuration
149
+ ### Configuration
94
150
 
95
151
  | Method | Details |
96
152
  |--------|---------|
97
153
  | Environment variable | `PATHMODE_API_KEY=pm_live_...` |
98
154
  | Config file | `~/.pathmode/config.json` with `apiKey`, `apiUrl`, `workspaceId` |
99
155
  | Local mode | `--local` flag — reads `intent.md` and `.pathmode/intents/*.md` |
156
+ | No config | Intent Compiler works without any configuration |
100
157
 
101
- Get your API key from **Settings > API Keys** in the [Pathmode app](https://pathmode.io).
102
-
103
- ## Tools
158
+ ### Team Tools
104
159
 
105
- ### Intent Management
160
+ #### Intent Management
106
161
 
107
- | Tool | Description | Annotations |
108
- |------|-------------|-------------|
109
- | `get_current_intent` | Get the active intent (first approved, or most recent) | readOnly |
110
- | `get_intent` | Get a single intent by ID with full details | readOnly |
111
- | `list_intents` | List all intents, optionally filtered by status | readOnly |
112
- | `search_intents` | Search intents by keyword across goals, objectives, and outcomes | readOnly |
113
- | `update_intent_status` | Update intent status (draft > validated > approved > shipped > verified) | write |
114
- | `log_implementation_note` | Record a technical decision or implementation note | write |
162
+ | Tool | Description |
163
+ |------|-------------|
164
+ | `get_current_intent` | Get the active intent (first approved, or most recent) |
165
+ | `get_intent` | Get a single intent by ID with full details |
166
+ | `list_intents` | List all intents, optionally filtered by status |
167
+ | `search_intents` | Search intents by keyword across goals, objectives, and outcomes |
168
+ | `update_intent_status` | Update intent status (draft > validated > approved > shipped > verified) |
169
+ | `log_implementation_note` | Record a technical decision or implementation note |
115
170
 
116
- ### Strategic Analysis
171
+ #### Strategic Analysis
117
172
 
118
- | Tool | Description | Annotations |
119
- |------|-------------|-------------|
120
- | `analyze_intent_graph` | Analyze dependency graph for critical path, cycles, bottlenecks, and risks | readOnly |
121
- | `get_intent_relations` | Get the dependency graph for a specific intent | readOnly |
173
+ | Tool | Description |
174
+ |------|-------------|
175
+ | `analyze_intent_graph` | Analyze dependency graph for critical path, cycles, bottlenecks |
176
+ | `get_intent_relations` | Get the dependency graph for a specific intent |
122
177
 
123
- ### Context & Export
178
+ #### Context & Export
124
179
 
125
- | Tool | Description | Annotations |
126
- |------|-------------|-------------|
127
- | `export_context` | Generate CLAUDE.md, .cursorrules, or intent.md files | readOnly |
128
- | `get_agent_prompt` | Get a structured execution prompt for an intent | readOnly |
129
- | `get_workspace` | Get workspace details including strategy and constitution | readOnly |
130
- | `get_constitution` | Get mandatory constraint rules for the workspace | readOnly |
180
+ | Tool | Description |
181
+ |------|-------------|
182
+ | `export_context` | Generate CLAUDE.md, .cursorrules, or intent.md files |
183
+ | `get_agent_prompt` | Get a structured execution prompt for an intent |
184
+ | `get_workspace` | Get workspace details including strategy and constitution |
185
+ | `get_constitution` | Get mandatory constraint rules for the workspace |
131
186
 
132
- ### Prompts
187
+ #### Team Prompts
133
188
 
134
189
  | Prompt | Description |
135
190
  |--------|-------------|
@@ -137,7 +192,7 @@ Get your API key from **Settings > API Keys** in the [Pathmode app](https://path
137
192
  | `review-risks` | Analyze the intent graph for architectural risks |
138
193
  | `what-next` | Suggest the highest-priority intent to work on next |
139
194
 
140
- ### Resources
195
+ #### Resources
141
196
 
142
197
  | URI | Description |
143
198
  |-----|-------------|
@@ -145,99 +200,37 @@ Get your API key from **Settings > API Keys** in the [Pathmode app](https://path
145
200
  | `intent://graph` | Full intent dependency graph |
146
201
  | `intent://workspace-strategy` | Workspace vision, principles, and active constitution rules |
147
202
 
148
- ## Usage Examples
149
-
150
- ### Example 1: Get Implementation Context
151
-
152
- **User prompt:** "What should I implement next?"
153
-
154
- **Expected tool calls:**
155
- 1. `get_current_intent` — Fetches the first approved intent
156
- 2. `get_agent_prompt` with `intentId` and `mode: "execute"` — Gets the structured implementation prompt
157
-
158
- **Expected output:** A full specification with objective, observable outcomes, constraints, edge cases, and verification steps that the AI agent uses to plan and execute the implementation.
159
-
160
- ---
161
-
162
- ### Example 2: Analyze Architectural Risks
163
-
164
- **User prompt:** "Are there any risks in our intent dependency graph?"
165
-
166
- **Expected tool calls:**
167
- 1. `analyze_intent_graph` with `analysis: "full"` — Runs complete graph analysis
168
-
169
- **Expected output:**
170
- ```json
171
- {
172
- "summary": { "total": 12, "statusDistribution": { "draft": 3, "approved": 5, "shipped": 4 } },
173
- "criticalPath": [
174
- { "id": "abc", "userGoal": "User authentication", "status": "shipped" },
175
- { "id": "def", "userGoal": "Role-based access control", "status": "approved" },
176
- { "id": "ghi", "userGoal": "Admin dashboard", "status": "draft" }
177
- ],
178
- "cycles": [],
179
- "bottlenecks": [
180
- { "id": "def", "userGoal": "Role-based access control", "dependentCount": 4, "status": "approved" }
181
- ],
182
- "orphanCount": 2
183
- }
184
- ```
185
-
186
- The AI agent summarizes: the critical path has 3 steps, "Role-based access control" is a bottleneck blocking 4 other intents and should be prioritized, and 2 intents have no relationships.
187
-
188
- ---
189
-
190
- ### Example 3: Generate a CLAUDE.md Context File
191
-
192
- **User prompt:** "Generate a CLAUDE.md for this project"
193
-
194
- **Expected tool calls:**
195
- 1. `export_context` with `format: "claude-md"` — Generates workspace context
196
-
197
- **Expected output:** A markdown file containing workspace strategy, active constitution rules, and all approved intents formatted as structured context that can be added to any project's `CLAUDE.md` file. The AI agent can write this directly to disk.
198
-
199
- ---
200
-
201
- ### Example 4: Search and Track Implementation
202
-
203
- **User prompt:** "Find all intents related to authentication and mark the login one as shipped"
204
-
205
- **Expected tool calls:**
206
- 1. `search_intents` with `query: "authentication"` — Finds matching intents
207
- 2. `update_intent_status` with `intentId` and `status: "shipped"` — Updates the login intent
208
- 3. `log_implementation_note` — Documents what was implemented
209
-
210
- **Expected output:** The search returns matching intents, the status is updated, and a note is logged documenting the implementation approach.
211
-
212
203
  ## Troubleshooting
213
204
 
214
205
  **"No Pathmode configuration found"**
215
- Set the `PATHMODE_API_KEY` environment variable or create `~/.pathmode/config.json`.
206
+ This no longer causes an error. The Intent Compiler works without any configuration. Team features require an API key.
216
207
 
217
208
  **Tools return "not available in local mode"**
218
- Most tools require cloud mode. Set up an API key, or use `--local` for basic intent reading from `intent.md` files.
209
+ Most team tools require cloud mode. Set up an API key, or use `--local` for basic intent reading.
219
210
 
220
211
  **Connection timeout**
221
- Ensure your API key is valid and has the correct scopes (read, write). Check your network connection to `pathmode.io`.
212
+ Ensure your API key is valid and has the correct scopes. Check your network connection to `pathmode.io`.
222
213
 
223
214
  ## Privacy Policy
224
215
 
225
216
  This MCP server connects to the Pathmode API (`pathmode.io`) to read and write intent specifications, workspace data, and constitution rules on behalf of the authenticated user.
226
217
 
227
- **Data collected:** The server transmits your API key for authentication and sends/receives workspace data (intents, constitution rules, workspace strategy) via the Pathmode API.
218
+ The **Intent Compiler** works entirely offline no data is sent to Pathmode servers. Specs are saved locally to your project directory.
228
219
 
229
- **Data storage:** The MCP server itself does not store any data locally (except in `--local` mode where it reads existing `intent.md` files from your project directory). All persistent data is stored in Pathmode's cloud infrastructure.
220
+ **Data collected (team features only):** The server transmits your API key for authentication and sends/receives workspace data via the Pathmode API.
230
221
 
231
- **Third-party sharing:** No data is shared with third parties. The server communicates exclusively with the Pathmode API.
222
+ **Data storage:** The MCP server does not store data locally (except `intent.md` files it creates and in `--local` mode). Persistent data is stored in Pathmode's cloud infrastructure.
232
223
 
233
- **Data retention:** Data retention follows Pathmode's standard data retention policies. See the full privacy policy at [https://pathmode.io/privacy](https://pathmode.io/privacy).
224
+ **Third-party sharing:** No data is shared with third parties. The server communicates exclusively with the Pathmode API.
234
225
 
235
- **Contact:** For privacy inquiries, contact privacy@pathmode.io.
226
+ Full privacy policy: [pathmode.io/privacy](https://pathmode.io/privacy)
236
227
 
237
- ## Support
228
+ ## Links
238
229
 
239
- - Issues: [github.com/pathmodeio/mcp-server/issues](https://github.com/pathmodeio/mcp-server/issues)
240
- - Documentation: [github.com/pathmodeio/mcp-server](https://github.com/pathmodeio/mcp-server#readme)
230
+ - [Intent Compiler page](https://pathmode.io/intent-compiler) — Overview and setup guide
231
+ - [Try in browser](https://pathmode.io/sandbox) — Interactive sandbox, no install needed
232
+ - [Pathmode](https://pathmode.io) — Full platform for teams
233
+ - [Issues](https://github.com/pathmodeio/mcp-server/issues)
241
234
 
242
235
  ## License
243
236
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pathmode/mcp-server",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "description": "Pathmode MCP Server — Build structured intent specs through Socratic AI conversation (zero-config), or connect to your Intent Layer for strategic context, dependency graphs, and implementation prompts.",
5
5
  "main": "dist/index.js",
6
6
  "bin": {