docs(mcp): troubleshooting row covers the MCP enum validation error - #34
Merged
Merged
Conversation
Since #23 each MCP tool's backend property is an enum of the configured backends, so the MCP SDK rejects an unknown backend before the handler runs with 'validating /properties/backend: enum: <x> does not equal any of: [...]', not the allow-list's 'backend ... is not enabled' text. The troubleshooting row now lists both messages and where each appears (HTTP API, and locate_bounding_boxes on a local-only server, still return the allow-list text). Verified with v0.1.2-4-gd1a3246: stdio dgem mcp --local and dgem serve --local /mcp both return the enum error; /api/decide and locate_bounding_boxes return the allow-list error.
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 (and to the troubleshooting table from #17 / #22).
Since #23, each MCP tool's
backendproperty is anenumof the configured backends. The MCP SDK therefore rejects an unknown backend before our handler runs, withvalidating /properties/backend: enum: vertex does not equal any of: [local]instead of the allow-list's
backend "vertex" is not enabled on this gateway (available: local). The troubleshooting row only listed the second message, so MCP users couldn't match the error they actually see.The row in
docs/reference/studio-mcp-api.md§3.4 (synced todocs-site/) now lists both messages and where each appears.Verification (binary
v0.1.2-4-gd1a3246)backend: "vertex"on a local-only serverdgem mcp --local,decide_custom_questionsenum: vertex does not equal any of: [local]dgem serve --local,POST /mcpdgem serve --local,POST /api/decide/support_triagebackend "vertex" is not enabled on this gateway (available: local)dgem mcp --local,locate_bounding_boxes(no enum on local-only by design)scripts/docs_link_check.py, the docs-site build andmake check-publicpass.Note:
make docs-sync-checkcurrently fails onmain, but not because of this PR. #29 addedPROP-17todocs/experiments/proposed.mdwithout syncingdocs-site/. I left it alone because open PR #33 edits the same file; runningscripts/docs_sync_page.py experiments/proposed.mdthere (or after it merges) fixes it. This PR's page passes the check.