docs(mcp): add standalone MCP user guide#190
Merged
Merged
Conversation
Adds docs/MCP_USER_GUIDE.md as the canonical user-facing guide for the agent-brain-mcp server. Covers the plugin-vs-MCP decision, per-host configuration (Claude Desktop, Cursor/Windsurf, Claude Agent SDK, LangChain DeepAgents via langchain-mcp-adapters), the full 7-tool / 5-resource / 6-prompt reference with input/output schemas drawn directly from agent_brain_mcp/schemas.py, three end-to-end worked examples, error mapping, cancellation, troubleshooting, and v2-v4 roadmap pointers. Trims the embedded MCP section in docs/USER_GUIDE.md (~90 lines) to a short summary that keeps one config snippet inline and links to the new guide. Refreshes agent-brain-mcp/README.md, clearing the stale "Phase 0 scaffold (10.0.7)" status (v1 shipped in 10.1.0) and adding the pip-install + "Full guide" pointer. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
docs/MCP_USER_GUIDE.md(680 lines) as the canonical user-facing guide foragent-brain-mcp: plugin-vs-MCP decision, per-host configuration (Claude Desktop, Cursor/Windsurf, Claude Agent SDK, LangChain DeepAgents vialangchain-mcp-adapters), full reference for all 7 tools / 5 resources / 6 prompts with input/output schemas pulled fromagent_brain_mcp/schemas.py, three end-to-end worked examples, error mapping, cancellation, troubleshooting, and v2–v4 roadmap pointers.docs/USER_GUIDE.md(~90 lines) to a short summary that keeps one config snippet inline and links to the new guide.agent-brain-mcp/README.md: clears the stale "Phase 0 scaffold (10.0.7)" status (v1 shipped in 10.1.0), addspip install agent-brain-ag-mcpand a "Full guide" pointer.docs/plans/2026-05-30-mcp-user-guide.md.Verification
Documentation-only change. Verified locally:
task before-push— passed (lint, typecheck, 416 tests, 80% coverage).tools/__init__.py,resources/corpus.py,prompts/__init__.py. Counts match (7 / 5 / 6); names byte-exact.search_documentsandindex_folderinput tables againstagent_brain_mcp/schemas.py. Defaults and constraints (e.g.top_k: int = 10 (1-100),alpha: float = 0.5 (0.0-1.0)) match field-for-field../PLUGIN_GUIDE.md,./USER_GUIDE.md,./API_REFERENCE.md,./CONFIGURATION.md,./GRAPHRAG_GUIDE.md,./plans/..., and./roadmaps/mcp/...reference resolves to a real file; the one anchor (#multi-project-support) is verified againstUSER_GUIDE.md.Test plan
docs/MCP_USER_GUIDE.mdin the GitHub web view; confirm tables and fenced JSON blocks display cleanly.langchain-mcp-adapterssnippets against the current upstream READMEs — the API shapes were fetched fresh via ctx7 (/anthropics/claude-agent-sdk-python,/langchain-ai/langchain-mcp-adapters) but worth a sanity check before publication.agent-brain start→ MCPtools/call index_folder→tools/call get_job) to confirm the JSON-RPC shapes are byte-exact.🤖 Generated with Claude Code