docs(mcp): document list_watches and cancel_watch in MCP integration table (#2110)#2134
Merged
qin-ctx merged 2 commits intoMay 20, 2026
Merged
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
qin-ctx
approved these changes
May 20, 2026
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
Updates the Available MCP Tools table in
docs/{en,zh}/guides/06-mcp-integration.mdto reflect the two new MCP tools added by #2110 (Watch Management API). Pre-#2110 the table claimed "9 tools" and listed 9 rows. After #2110 the MCP endpoint exposes 11 tools (list_watches+cancel_watchadded inopenviking/server/mcp_endpoint.pyL618 / L655), so the integration guide that clients land on for tool discovery is now stale by 2 rows and a count.This catch is scoped to the client-facing setup guide only. The deeper API reference (REST routes, CLI subcommands, MCP closure rationale) for the same feature is covered separately in #2123 under
docs/{en,zh}/api/02-resources.md. Zero file overlap with #2123.Why this matters
A user wiring up an MCP client lands on
guides/06-mcp-integration.mdto discover what tools OpenViking advertises. The current table omitslist_watchesandcancel_watch, so:Source of truth
All description and parameter text is paraphrased verbatim from the docstrings on the two
@mcp.tool()decorated functions inopenviking/server/mcp_endpoint.py(commit fc5ed54):list_watches() -> str— no parameters, per-agent visibility, returns table-formatted lines.cancel_watch(to_uri: str) -> str— single required URI parameter, must match the watch task'stovalue.The trailing note ("Pause / resume / trigger / update intentionally not exposed") is paraphrased from the source-of-truth comment block at
mcp_endpoint.pyL609-614, which explicitly says MCP exposes the minimum closure and points power users at REST orov task watchCLI.Changes
docs/en/guides/06-mcp-integration.md:9 tools→11 tools, insert 2 rows after theadd_resourcerow, append a one-line note pointing watch power-users at REST / CLI for the remaining verbs.docs/zh/guides/06-mcp-integration.md: mirrored ZH update with the same byte-mirror structure.Net: +8 LOC additive, 0 deletions other than the count number.
Test plan
openviking/server/mcp_endpoint.pyat HEAD (commit fc5ed54).add_resourcewatch_interval parameter description left untouched; this PR only adds rows + count + closing note.