Skip to content

docs(mcp): document code_outline / code_search / code_expand from #2146#2176

Merged
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-mcp-integration-code-tools-2146
May 22, 2026
Merged

docs(mcp): document code_outline / code_search / code_expand from #2146#2176
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-mcp-integration-code-tools-2146

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

Updates the Available MCP Tools table in docs/{en,zh}/guides/06-mcp-integration.md to reflect the three new MCP tools added by #2146 (code_outline / code_search / code_expand). Pre-#2146 the table claimed "11 tools" and listed 11 rows; after #2146 the MCP endpoint exposes the three additional code-navigation tools at openviking/server/mcp_endpoint.py L840 / L864 / L914. The client-facing setup guide users land on for tool discovery is now stale by three rows and a count.

Why this matters

The integration guide is where MCP clients (Claude / Manus / OpenClaw / VikingBot) discover what tools the endpoint actually exposes. Without these three rows agents miss the code_search → code_outline → code_expand workflow this PR was specifically designed to enable; users have to read openviking/server/mcp_endpoint.py to find out the tools exist.

Same form as #2134 (list_watches + cancel_watch catch of #2110) — narrow scope, dual-doc parity, no semantic change to the prose around the table.

Changes

  • EN + ZH docs/.../guides/06-mcp-integration.md: count 1114; insert 3 rows between forget and health matching source-file order in mcp_endpoint.py.
  • Row content grounded byte-for-byte in the docstrings and signatures introduced by feat(mcp): add code navigation tools (code_outline / code_search / code_expand) #2146:
    • code_outline(uri) — file URI, returns symbol structure without bodies.
    • code_search(query, uri) — directory URI, scans up to 200 source files, narrow uri for deeper coverage.
    • code_expand(uri, symbol) — file URI, symbol accepts bar (top-level) or Foo.bar (method).
  • Surrounding "Note" about watch-management closure is unchanged (different surface).

12 LOC (6 EN + 6 ZH — 3 row inserts + count edits, each side).

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

2146 - Fully compliant

Compliant requirements:

  • The MCP integration guide now documents the three new code navigation tools in both English and Chinese.
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@qin-ctx qin-ctx merged commit 01b9b3d into volcengine:main May 22, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants