@getripple/mcp 1.0.4 → 1.0.5

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 (3) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +71 -30
  3. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @getripple/mcp Changelog
2
2
 
3
+ ## [1.0.5] - 2026-06-04
4
+
5
+ ### Changed
6
+ - Refresh package README wording for npm users configuring AI agents.
7
+ - Lead with the MCP config snippet and the before-edit / after-edit / gate / repair workflow.
8
+ - Clarify stdio protocol behavior and local privacy posture.
9
+
3
10
  ## [1.0.4] - 2026-06-03
4
11
 
5
12
  ### Fixed
package/README.md CHANGED
@@ -3,7 +3,14 @@
3
3
  MCP stdio server for AI agents that need Ripple's architectural context before
4
4
  editing code.
5
5
 
6
- Paste this into an MCP-compatible client:
6
+ The server lets agents call Ripple directly instead of reading markdown files.
7
+ Plan before edit. Check after edit. Catch drift. Tell the agent what to fix.
8
+
9
+ ## Setup
10
+
11
+ Paste this into your MCP-compatible client (Claude Code, Cursor, or any MCP host).
12
+
13
+ Replace the workspace path with the absolute path to your project.
7
14
 
8
15
  ```json
9
16
  {
@@ -21,38 +28,74 @@ Paste this into an MCP-compatible client:
21
28
  }
22
29
  ```
23
30
 
24
- The server lets agents call Ripple directly instead of scraping markdown files.
25
- It does not sandbox file writes by itself; MCP clients, CLI checks, CI gates, or
26
- human review must obey Ripple's continue/stop decisions.
31
+ **macOS / Linux:** `/Users/yourname/projects/myapp`
32
+ **Windows:** `C:\\Users\\yourname\\projects\\myapp`
33
+
34
+ No install required. `npx` fetches and runs the server automatically.
27
35
 
28
- ## Tools
36
+ ## Agent Workflow
29
37
 
30
- ```txt
31
- ripple_get_agent_workflow
32
- ripple_doctor
38
+ Call these tools in order:
39
+
40
+ **1. Before editing — get context and save intent:**
41
+
42
+ ```
33
43
  ripple_plan_context
44
+ ```
45
+
46
+ Returns the files to read first, risk level, allowed boundary, and verification
47
+ targets. Pass `save: true` to record the intent for drift checking.
48
+
49
+ **2. After editing and staging — check for drift:**
50
+
51
+ ```
34
52
  ripple_check_staged
35
- ripple_check_changed
36
- ripple_audit_change
53
+ ```
54
+
55
+ Compares staged changes against the saved intent. Returns intent drift, boundary
56
+ drift, policy drift, and readiness drift in a single verdict.
57
+
58
+ **3. When you only need continue or stop:**
59
+
60
+ ```
37
61
  ripple_gate
38
- ripple_get_approval_status
62
+ ```
63
+
64
+ Returns the compact decision the agent needs to proceed or pause for human review.
65
+
66
+ **4. If drift is detected — get the repair plan:**
67
+
68
+ ```
39
69
  ripple_repair_intent_drift
40
- ripple_get_focus
41
- ripple_get_blast_radius
42
- ripple_explain_policy
43
- ripple_get_recent_changes
44
70
  ```
45
71
 
46
- Use `ripple_plan_context` before editing to save task intent and control
47
- boundary. Use `ripple_check_staged` or `ripple_audit_change` after editing to
48
- detect intent drift, boundary drift, policy drift, and readiness drift. Use
49
- `ripple_gate` when the agent only needs the compact continue/stop decision.
72
+ Returns specific actions: which files to unstage, which contracts to review, and
73
+ what to verify before widening scope.
74
+
75
+ ## All Tools
50
76
 
51
- ## Local Run
77
+ ```
78
+ ripple_get_agent_workflow — full agent workflow guide and loop
79
+ ripple_doctor — check project readiness before scanning
80
+ ripple_plan_context — plan before editing a target file
81
+ ripple_check_staged — check staged changes against saved intent
82
+ ripple_check_changed — check changed files against a git base ref
83
+ ripple_audit_change — audit a completed change for drift signals
84
+ ripple_gate — compact continue/stop decision
85
+ ripple_get_approval_status — check whether a human gate is required
86
+ ripple_repair_intent_drift — get repair actions when drift is detected
87
+ ripple_get_focus — focused context for a single file
88
+ ripple_get_blast_radius — files that depend on a target file
89
+ ripple_explain_policy — explain the active trust boundary policy
90
+ ripple_get_recent_changes — recent architectural changes from history
91
+ ```
52
92
 
53
- After install:
93
+ ## Run Without Config
94
+
95
+ After global install:
54
96
 
55
97
  ```bash
98
+ npm install -g @getripple/mcp
56
99
  ripple-mcp --workspace /absolute/path/to/your/repo
57
100
  ```
58
101
 
@@ -62,18 +105,16 @@ Without installing:
62
105
  npx -y @getripple/mcp --workspace /absolute/path/to/your/repo
63
106
  ```
64
107
 
65
- For local monorepo development:
108
+ ## Protocol
66
109
 
67
- ```bash
68
- npm run build:mcp
69
- node packages/mcp/dist/server.js --workspace /absolute/path/to/your/repo
70
- ```
110
+ The server communicates over stdio using newline-delimited JSON-RPC. Only
111
+ JSON-RPC messages are written to stdout. Scan progress and logs are written to
112
+ stderr so MCP clients can parse responses without noise.
71
113
 
72
- ## Protocol Notes
114
+ ## Privacy
73
115
 
74
- The server speaks newline-delimited JSON-RPC over stdio. Only JSON-RPC messages
75
- are written to stdout; scan logs are redirected to stderr so MCP clients can
76
- parse responses safely.
116
+ Ripple runs entirely on your machine. No account, telemetry, cloud indexing, or
117
+ remote model call is required.
77
118
 
78
119
  ## Status
79
120
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getripple/mcp",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "description": "MCP stdio server for Ripple's local AI-agent workflow engine.",
5
5
  "license": "MIT",
6
6
  "type": "commonjs",
@@ -45,7 +45,7 @@
45
45
  "build": "tsc -p tsconfig.json"
46
46
  },
47
47
  "dependencies": {
48
- "@getripple/core": "^1.0.4"
48
+ "@getripple/core": "^1.0.5"
49
49
  },
50
50
  "devDependencies": {
51
51
  "@types/node": "^18.0.0",