From abacdd5a235415720de0a4101aff8fd82ea13d60 Mon Sep 17 00:00:00 2001 From: Sattvik Kansal Date: Thu, 23 Jul 2026 22:04:24 -0700 Subject: [PATCH] =?UTF-8?q?docs(GUIDES):=20MCP=20install=20step=20?= =?UTF-8?q?=E2=80=94=20clone+link,=20plus=20the=20npx-form=20server=20conf?= =?UTF-8?q?ig?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The step-1 install was the plain -g github: form, which fails (#25 — npm prepares the nested github: deps without their node_modules). Swap in the README's clone+link recipe and add the no-install npx-form MCP config, both verified working (initialize handshake over stdio). --- docs/GUIDES.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/GUIDES.md b/docs/GUIDES.md index 4100564..eddd378 100644 --- a/docs/GUIDES.md +++ b/docs/GUIDES.md @@ -152,9 +152,10 @@ $ rome preset foundry hadrian Give your coding agent grounded Rome facts so it stops guessing addresses and selectors. -**1. Install** (repo-first; npm publish pending): +**1. Install** (repo-first; npm publish pending) — clone + link. A plain `npm install -g github:…` fails: npm prepares this package's `github:` dependencies without their own `node_modules` ([#25](https://github.com/rome-protocol/rome-cli/issues/25)): ```bash -npm install -g github:rome-protocol/rome-cli#v0.9.0 +git clone https://github.com/rome-protocol/rome-cli +cd rome-cli && npm install && npm install -g . ``` **2. Register the MCP server** in your client's config. You don't run or host anything — the client launches `rome mcp` on demand. @@ -163,7 +164,10 @@ npm install -g github:rome-protocol/rome-cli#v0.9.0 ```json { "mcpServers": { "rome": { "command": "rome", "args": ["mcp"] } } } ``` -*Claude Desktop / Cursor* — the same block in their MCP config. +*Claude Desktop / Cursor* — the same block in their MCP config. Skipping the install? The npx form works too: +```json +{ "mcpServers": { "rome": { "command": "npx", "args": ["-y", "github:rome-protocol/rome-cli", "mcp"] } } } +``` **3. Verify** the tools are live: ```bash