Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 66 additions & 0 deletions docs/remcp/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
slug: /
title: Getting Started
sidebar_position: 0
---
# Quick Install

**One-line install (macOS and Linux)**
```
curl -sSL https://storage.googleapis.com/remcp/install.sh | bash
```
📝 Next steps:
1. Make sure `$HOME/.local/bin` is in your `PATH`. Add to `~/.bashrc` or `~/.zshrc`:

```export PATH="$HOME/.local/bin:$PATH"```

2. Authenticate with GitHub:

```remcp auth```

3. Add to Claude Code:

```claude mcp add recurse --scope user -- remcp serve```


# Usage tips:

## Configure claude code (recommended)

```bash
remcp configure claude
```
This installs a SessionStart hook that automatically reminds Claude to use remcp. This is a global configuration for claude.


If you are not happy with the global setting, you can remove it using the following
```bash
remcp configure claude --remove
```

## Recurse prompt

```
# In claude code
$ /recurse:review_code Please implement access control on web api endpoints
Comment thread
ab-10 marked this conversation as resolved.
```
The prompt is automatically available once you install remcp, and claude will start using Recurse MCP for code changes.


## Project level configuration (manual)


To help your AI agent automatically use remcp, add instructions to your agent's rules file:

| MCP Client | Rules File Location |
|------------|---------------------|
| Claude Desktop/Code | `CLAUDE.md` |
| VSCode Copilot | `.github/copilot-instructions.md` |
| Cursor | `.cursorrules` or `.cursor/rules` |

**Add this line to your rules file:**

```
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
```

14 changes: 14 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,15 @@ const config: Config = {
sidebarPath: './sidebars.ts',
lastVersion: 'current',
}],
[
'@docusaurus/plugin-content-docs',
{
id: 'remcp',
path: 'docs/remcp',
routeBasePath: 'remcp',
sidebarPath: './sidebars.ts',
lastVersion: 'current',
}],

],
presets: [
Expand Down Expand Up @@ -121,6 +130,11 @@ const config: Config = {
label: 'RML CLI',
position: 'left',
},
{
to: '/remcp/',
label: 'REMCP',
position: 'left',
},
// { to: '/blog', label: 'Blog', position: 'left' },
{
href: 'https://github.com/recurse-ml/docs',
Expand Down
28 changes: 28 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ function HomepageProjects() {
description="Identify bugs in your local code changes. Works with all code - human-written or AI-generated."
imageUrl="/img/rml-logo.svg"
href="/rml" />
<ProjectButton
title="REMCP"
description="Model Context Protocol server for Recurse ML integration."
imageUrl="/img/mcp.png"
href="/remcp" />

</div>

Expand Down
Binary file added static/img/mcp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.