Skip to content

Commit 446a1b7

Browse files
committed
Refine the MCP server content
Signed-off-by: popcorny <[email protected]>
1 parent 41cd96d commit 446a1b7

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

docs/5-data-diffing/mcp-server.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,31 @@
22
title: MCP Server
33
---
44

5-
Recce allows you to expose its tools to AI agents for integration. Here's how to use Claude Code to integrate with Recce.
5+
Recce exposes its tools to AI agents, enabling integration with tools like Claude Code. This allows you to interact with Recce analysis through natural language queries directly in your Claude Code sessions.
66

77

8-
## Method 1: MCP Server
8+
## Installation
99

10-
To use Recce in Claude Code, add an MCP server to your project. Claude Code will launch the MCP server when the session starts.
10+
1. Install Recce with the MCP extra dependency:
1111

12-
1. Add Recce to your dbt project
12+
```shell
13+
pip install 'recce[mcp]'
14+
```
15+
16+
2. Verify the MCP server works by starting it in your dbt project:
17+
18+
```shell
19+
cd my-dbt-project/
20+
recce mcp-server
21+
```
22+
23+
You should see the message: `Starting Recce MCP Server in stdio mode...` Stop the server with `Ctrl+C` once confirmed.
24+
25+
## Method 1: MCP Server (stdio)
26+
27+
Configure Recce as an MCP server with stdio transport. Claude Code will automatically launch the MCP server when you start a session.
28+
29+
1. Configure the MCP server for your dbt project:
1330

1431
```shell
1532
claude mcp add --scope project recce -- recce mcp-server
@@ -29,28 +46,28 @@ To use Recce in Claude Code, add an MCP server to your project. Claude Code will
2946

3047
## Method 2: MCP Server (SSE)
3148

32-
Alternatively, you can launch a standalone MCP server. Claude Code will connect to it using HTTP-SSE.
49+
Alternatively, launch a standalone MCP server that Claude Code connects to via HTTP-SSE. This requires running the server in a separate terminal.
3350

34-
1. Add Recce to your dbt project
51+
1. Configure the MCP server for your dbt project:
3552

3653
```shell
3754
claude mcp add --transport sse --scope project recce http://localhost:8000/sse
3855
```
3956

40-
2. Launch the standalone MCP server with HTTP-SSE
57+
2. In a separate terminal, start the standalone MCP server:
4158

4259
```shell
4360
cd my-dbt-project/
4461
recce mcp-server --sse
4562
```
4663

47-
3. Run Claude Code
64+
3. In your original terminal, run Claude Code:
4865

4966
```shell
5067
claude
5168
```
5269

53-
4. Ask Claude Code about your changes
70+
4. Ask Claude Code about your changes:
5471

5572
```shell
5673
> Understand changes from Recce.

0 commit comments

Comments
 (0)