docs(DRC-2735): update available tools table with accurate tool list#85
Merged
docs(DRC-2735): update available tools table with accurate tool list#85
Conversation
Add list_checks and run_check to the tools table. Move value_diff, top_k_diff, and histogram_diff to a separate section noting they are accessible via run_check. Add server modes note explaining tool availability in preview/read-only modes. Closes DRC-2735 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Kent <iamcxa@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Recce MCP server documentation to accurately reflect which MCP tools are directly available vs which diff “check types” are executed indirectly through preset checks.
Changes:
- Adds the missing direct MCP tools
list_checksandrun_checkto the “Available tools” table. - Moves
value_diff,top_k_diff, andhistogram_diffinto a dedicated subsection as additional check types executed viarun_check. - Adds a “Server modes” note describing reduced tool availability in preview/read-only modes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Use "Run" instead of "Execute", clarify "MCP server modes" to avoid confusion with database servers, and improve section heading and description phrasing per project writing principles. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Explicitly state that server mode exposes all tools, making the relationship between the tools table and the modes note unambiguous. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update prerequisites, server modes, and troubleshooting to reflect the new single-env onboarding mode where the MCP server starts without target-base/ artifacts. Depends on DataRecce/recce#1175 (DRC-2795). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
wcchang1115
requested changes
Mar 5, 2026
Contributor
wcchang1115
left a comment
There was a problem hiding this comment.
Hi kc,
Please check as we discussed.
…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>
Contributor
Author
|
All review feedback addressed — please see individual thread replies for details. |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
list_checksandrun_checkto the MCP server available tools tablevalue_diff,top_k_diff,histogram_diffto a separate "Check types available throughrun_check" section — these are not direct MCP tools but accessible indirectly through preset checksDependencies
Context
The existing tools table listed
value_diff,top_k_diff, andhistogram_diffas direct MCP tools, but they are actually check types accessible only via therun_checktool. Meanwhilelist_checksandrun_check— which are real MCP tools — were missing from the table.Additionally, DRC-2795 introduces a single-environment mode that changes how the MCP server handles missing base artifacts (
target-base/). Previously the server refused to start; now it falls back to single-env mode where all tools work but diffs show no changes. This lowers the onboarding barrier — users only needdbt docs generateto start exploring the MCP server, and can add base artifacts later for real comparisons.Source code evidence
All changes verified against
recce/mcp_server.py:8 direct MCP tools (not 5+3)
The
list_tools()handler registers tools in two groups:lineage_diff,schema_diffrow_count_diff,query,query_diff,profile_diff,list_checks,run_checkvalue_diff,top_k_diff,histogram_diffare not registered as MCP tools — they are check types executed indirectly viarun_check→submit_run()(L793–L799).Server modes: only
lineage_diffandschema_diffin preview/read-onlyThe
call_tool()handler explicitly blocks 6 tools in non-server modes (L419–L431):Single-environment mode (DRC-2795, recce#1175)
When
target-base/is missing, CLI auto-detects and enables single-env mode (cli.py L1815–L1830):target_base_path = target_pathso both environments load the same artifacts_warningfield: "Base environment not configured — comparisons show no changes"Terminology fixes
Per the project's writing-principles.md and terminology.md:
Linked issues
Test plan
mkdocs serverenders the updated section correctlyrun_checknote🤖 Generated with Claude Code