docs(mcp): sync tool parameters and response fields with appserver - #41
Merged
Conversation
Verified every tool against appserver's code/components/mcp/tools/. PR #23 corrected the tool inventory; these are the remaining gaps in the per-tool parameter and response documentation. - list_applications: `type` is ios/android/javascript/rust/web, not ios/android/web. `web` is legacy and not creatable. - list_issues: document `symbolication_status`, that unsymbolicated issues are listed alongside ready ones and often carry an empty `key`, and that log data is not available from this tool. - get_issue: document `issue_id` (the alternative to `issue_key`, and the only way to address an unsymbolicated issue) and `include_attributes`; add the Labels, Attributes, and Report source response sections. - get_issue_resource: document `issue_id`. - Drop the Prompts section. The server registers no MCP prompts — `bugsee_fix` appears nowhere in appserver, including its history. - configuration.md: the granted scope is the mcp:read default, not the only scope; a client may request mcp:write, and consent can narrow it back. - security.md: note that Dynamic Client Registration defaults to mcp:read, so write access cannot be requested by a client that never registered for it. - index.md: mention symbols in the data summary; add symbolication diagnostics and app onboarding to the capability list. - usage.md: add worked examples for the two tools PR #23 introduced. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Change-Id: I9a527e0f76b4d01bd87a70a0355124884b695b04
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
1 participant
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.
Follow-up to #23. That PR corrected the tool inventory (thirteen tools, four families, the two mutating tools). This one closes the remaining gaps in the per-tool parameter and response documentation, verified tool by tool against
appserver/code/components/mcp/tools/.Corrections
usage.mdlist_applicationstypeisios/android/webios,android,javascript,rust,web— perconfig.applications.types;webis legacy and not creatableusage.mdlist_issuesresponse omitssymbolication_statuskeyusage.mdget_issuetakesissue_key(required)issue_keyorissue_id—issue_idis the only way to address an unsymbolicated issueusage.mdget_issuehas noinclude_attributesusage.mdget_issue_resourcetakesissue_key(required)issue_keyorissue_idconfiguration.mdmcp:read"mcp:readis the default; a client may requestmcp:write, and consent can narrow it backRemoved
The Prompts section, advertising a
/bugsee_fixMCP prompt. The server registers no prompts — there is noregisterPromptcall in appserver, andbugsee_fixappears nowhere in the repo or its git history.Added
security.md: Dynamic Client Registration defaults tomcp:read(DEFAULT_DCR_SCOPES), so a client that never registered for write access cannot request it on a consent screen.index.md: symbols in the data summary; symbolication diagnostics and app onboarding in the capability list.usage.md: worked examples forget_symbol_by_uuidandcreate_application, the two tools docs(mcp): correct the tool inventory and read-only claims #23 introduced.Prose for the
create_applicationandget_symbol_by_uuidsections is left as #23 wrote it.Verification
npx cspell "docs/**/*.md" "docs/**/*.mdx"— cleannpm run build— succeeds (the two SSG warnings on/sdk/dotnet/network/and/sdk/xamarin/network/are pre-existing and unrelated)🤖 Generated with Claude Code