Skip to content

Commit 89985e0

Browse files
authored
RML-440, RML-441: Add installation instructions separately for claude and cursor (#19)
* Add installation instructions separately for claude and cursor * Add an image where user rules are to be configured in cursor
1 parent a87ffd8 commit 89985e0

5 files changed

Lines changed: 122 additions & 39 deletions

File tree

docs/remcp/index.mdx

Lines changed: 12 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -9,58 +9,31 @@ sidebar_position: 0
99
```
1010
curl -L remcp.recurse.ml | bash
1111
```
12+
1213
📝 Next steps:
1314
1. Make sure `$HOME/.local/bin` is in your `PATH`. Add to `~/.bashrc` or `~/.zshrc`:
1415

15-
```export PATH="$HOME/.local/bin:$PATH"```
16-
17-
2. Authenticate with GitHub:
18-
19-
```remcp auth```
20-
21-
3. Add to Claude Code:
22-
23-
```claude mcp add recurse --scope user -- remcp serve```
24-
25-
26-
# Usage tips:
27-
28-
## Recurse prompt (recommended)
29-
3016
```
31-
# In claude code
32-
$ /recurse:review_code Please implement access control on web api endpoints
17+
export PATH="$HOME/.local/bin:$PATH"
3318
```
34-
The prompt is automatically available once you install remcp, and claude will start using Recurse MCP for code changes.
3519

36-
## Configure claude code
20+
2. Authenticate with GitHub:
3721

38-
```bash
39-
remcp configure claude
4022
```
41-
This installs a SessionStart hook that automatically reminds Claude to use remcp. This is a global configuration for claude.
42-
43-
44-
If you are not happy with the global setting, you can remove it using the following
45-
```bash
46-
remcp configure claude --remove
23+
remcp auth
4724
```
4825

26+
3. Choose your IDE and follow the installation instructions:
4927

50-
## Project level configuration (manual)
28+
- [Install in Claude Code](./installation/install-claude-code)
29+
- [Install in Cursor](./installation/install-cursor)
5130

31+
# Usage tips
5232

53-
To help your AI agent automatically use remcp, add instructions to your agent's rules file:
54-
55-
| MCP Client | Rules File Location |
56-
|------------|---------------------|
57-
| Claude Desktop/Code | `CLAUDE.md` |
58-
| VSCode Copilot | `.github/copilot-instructions.md` |
59-
| Cursor | `.cursorrules` or `.cursor/rules` |
60-
61-
**Add this line to your rules file:**
33+
### Recurse prompt (recommended)
6234

6335
```
64-
Use recurse MCP to verify your work while completing the following task. Before making any changes call init() on the project if not already done, once all changes are done call check() to get bug reports
36+
# In claude code
37+
$ /recurse:review_code Please implement access control on web api endpoints
6538
```
66-
39+
The prompt is automatically available once you install remcp, and claude will start using Recurse MCP for analyzing code changes.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Installation",
3+
"position": 1
4+
}
5+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
slug: install-claude-code
3+
title: Install in Claude Code
4+
sidebar_position: 1
5+
---
6+
# Install in Claude Code
7+
8+
## Step 1: Add MCP to claude
9+
10+
11+
```
12+
claude mcp add recurse --scope user -- remcp serve
13+
```
14+
15+
## Step 2: Install hooks
16+
17+
18+
```bash
19+
remcp configure claude
20+
```
21+
22+
This installs a SessionStart hook that automatically reminds Claude to use remcp. This is a global configuration for Claude.
23+
24+
## Removing the Configuration
25+
26+
If you are not happy with the hook, you can remove it using:
27+
28+
```bash
29+
remcp configure --remove claude
30+
```
31+
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
slug: install-cursor
3+
title: Install in Cursor
4+
sidebar_position: 2
5+
---
6+
# Install in Cursor
7+
8+
## Step 1: Configure remcp
9+
10+
Run the following command to configure remcp for Cursor:
11+
12+
```bash
13+
remcp configure cursor
14+
```
15+
16+
## Step 2: Add a User Rule
17+
18+
Add the following user rule in your Cursor settings:
19+
20+
![Cursor User Rule Example](/img/cursor-user-rules.png)
21+
<details>
22+
<summary>Click to expand: Cursor User Rule</summary>
23+
24+
```yaml
25+
---
26+
name: Verify Changes Using Recurse ML MCP
27+
28+
globs: "**/*.{js,ts,py,rs,go,java,rb,cs,tsx,jsx}"
29+
30+
alwaysApply: true
31+
32+
description: Use Recurse ML MCP to verify your work. Before making changes, call init() on the project if not already done. Once all changes are done, call check() to get bug reports.
33+
---
34+
35+
# Verify Changes Using Recurse ML MCP
36+
37+
Use Recurse ML MCP to verify your work while completing tasks. Before making any changes, call `init()` on the project if not already done. Once all changes are done, call `check()` to get bug reports.
38+
39+
## Do
40+
41+
1. Call `mcp_recurse_init()` before making changes to initialize the project for analysis.
42+
2. Call `mcp_recurse_check()` after completing your changes to get bug reports.
43+
3. Investigate the bug reports and fix valid issues.
44+
4. Use `mcp_recurse_ignore_issue()` if you're aware of an issue but choose not to address it.
45+
46+
## Don't
47+
48+
1. DON'T skip initialization - always call `init()` before starting work.
49+
2. DON'T forget to call `check()` after completing changes.
50+
3. DON'T ignore bug reports without investigating them first.
51+
52+
## MCP Usage
53+
54+
The Recurse ML MCP provides the following tools:
55+
56+
- `mcp_recurse_init(repo_path)`: Initialize a codebase for analysis. Sets up the project for continuous analysis by performing health checks, creating a project entry in the database, and starting the background worker (if not already running).
57+
58+
- `mcp_recurse_check(project_id)`: Check the status of the latest analysis and retrieve any issues found. This should be fast (<1s) as it just reads from the database. The tool might report that an analysis is pending, which means you need to call it again in some time until it says that the analysis either succeeded or errored out.
59+
60+
- `mcp_recurse_ignore_issue(issue_id)`: Indicate that you're aware of an issue but choose not to address it.
61+
62+
- `mcp_recurse_doctor()`: Run diagnostic checks to troubleshoot installation and configuration issues.
63+
64+
## Workflow
65+
66+
1. **Before making changes**: Call `mcp_recurse_init()` with the absolute path to the repository root.
67+
2. **After completing changes**: Call `mcp_recurse_check()` with the project_id returned from init().
68+
3. **If bugs are found**: Review the bug reports, verify whether they are valid, and fix them.
69+
4. **If analysis is pending**: Wait a moment and call `check()` again until the analysis completes.
70+
```
71+
72+
</details>
73+
74+

static/img/cursor-user-rules.png

182 KB
Loading

0 commit comments

Comments
 (0)