Skip to content

docs(GUIDES): MCP install step — clone+link + npx-form config #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skansal-rome merged 1 commit into from
Jul 24, 2026
Merged

docs(GUIDES): MCP install step — clone+link + npx-form config #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/GUIDES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
Loading