Skip to content

Commit 6e8ca00

Browse files
iamcxaclaude
andcommitted
docs(mcp): address review - simplify modes, keep dbt wording, remove git stash
- Remove server modes admonition per reviewer feedback (focus on server mode) - Keep "dbt artifacts" instead of generic "development artifacts" - Replace git stash troubleshooting steps with link to prerequisites Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent cd5d740 commit 6e8ca00

1 file changed

Lines changed: 4 additions & 12 deletions

File tree

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

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -224,16 +224,14 @@ These check types are accessible as preset checks configured in `recce.yml` or c
224224

225225
See [Preset checks](../7-cicd/preset-checks.md) for how to configure these check types.
226226

227-
!!! note "MCP server modes"
228-
The MCP server supports three modes: **server** (default), **preview**, and **read-only**. In **server** mode, all of the tools listed above are available. In **preview** and **read-only** modes, only `lineage_diff` and `schema_diff` are available — tools that query your warehouse are disabled.
229-
230-
If base artifacts (`target-base/`) are not present, the server starts in **single-environment mode** where all tools work but diffs show no changes. Diff responses include a `_warning` field reminding you to generate base artifacts.
227+
!!! note
228+
If base artifacts (`target-base/`) are not present, the server starts in **single-environment mode** — all tools remain available, but diff results show no changes. Generate base artifacts to enable real comparisons.
231229

232230
## Troubleshooting
233231

234232
### MCP server fails to start
235233

236-
The most common cause is missing development artifacts. Check that your development artifacts exist:
234+
The most common cause is missing dbt artifacts. Check that your dbt artifacts exist:
237235

238236
```shell
239237
ls target/manifest.json
@@ -243,13 +241,7 @@ If missing, run `dbt docs generate` in your current branch. See [Prerequisites](
243241

244242
### Diff results show no changes
245243

246-
If the server starts but all diffs return empty results, you are likely in single-environment mode (missing base artifacts). Generate base artifacts to enable real comparisons:
247-
248-
```shell
249-
git stash && git checkout main
250-
dbt docs generate --target-path target-base
251-
git checkout <your-branch> && git stash pop
252-
```
244+
If the server starts but all diffs return empty results, you are likely in single-environment mode (missing base artifacts). Follow the [Generate base artifacts](#generate-base-artifacts) steps to enable real comparisons.
253245

254246
### Port already in use (SSE mode)
255247

0 commit comments

Comments
 (0)