Sync checkout-api-reference steering docs with the live dx-mcp tool contract - #200
Open
huseyin-caglayan-cko wants to merge 3 commits into
Conversation
Real snake_case tool names, add docs_fetch + support_search, correct docs_search to the pointer + docs_fetch two-step, bump version to 2.3.0.
Real snake_case tool names, correct "six tools" -> eight, add docs_fetch and support_search, document the docs_search -> docs_fetch two-step.
Real snake_case tool names throughout, add docs_fetch + support_search guidance and the docs_search -> docs_fetch chunking contract.
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.
Summary
The
checkout-api-referencepower's steering docs describe a tool contract that doesn't match the live server athttps://docs.mcp.checkout.com/rpc. This PR syncscheckout/POWER.mdand both steering files with what the server actually exposes today (verified against livetools/list).I'm the maintainer of the upstream server (
cko-web/dx-mcp); these docs are now generated from that repo'spower/directory, which is the source of truth for the tool contract.What was wrong
Two separate drifts had accumulated:
ApiSearch,ListOperations,GetOperation,GetSchema,DocsSearch,Guide— but the server's tools are snake_case (api_search,list_operations,get_operation,get_schema,docs_search,guide). The PascalCase names returnUnknown tool.support_search(support-site search) was undocumented.docs_fetchwas undocumented — and it's load-bearing:docs_searchnow returns document pointers only (urlPath,whyMatched,summary,totalChunks,matchedChunk), and reading a page requires a seconddocs_fetch(urlPath, chunk)call, paging throughchunk1..totalChunkswhilehasMoreis true. None of that chunking contract was described.What changed
checkout/POWER.md— all 8 tools documented with correct snake_case names;docs_search/docs_fetchtwo-step described; version bumped2.0.0→2.3.0to match the server release; added a read-only note and support/troubleshooting keywords.checkout/steering/getting-started.md— "six tools" → eight; correct names; addeddocs_fetchandsupport_searchsections and the search→fetch contract.checkout/steering/advanced-usage.md— snake_case names throughout every example; added the docs/support tool-selection guidance and the chunking contract.checkout/mcp.jsonis unchanged (endpoint is identical).Verification
Tool names, the pointer/chunk retrieval model, and the presence of all 8 tools were confirmed by live
tools/listand tool calls against the production endpoint. On the server side these are covered by an annotation/contract test incko-web/dx-mcp, so the two won't drift apart again.