docs: clarify the idempotency-key server contract in the checkout MCP binding - #679
Open
YanisMtcr wants to merge 1 commit into
Open
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
… binding The MCP binding requires meta["idempotency-key"] on complete_checkout and cancel_checkout but does not state the server-side idempotency contract, which is only spelled out in the REST binding and the overview error registry. Add a short Idempotency subsection that states it by reference, without restating the full contract.
YanisMtcr
force-pushed
the
docs/mcp-idempotency-contract
branch
from
August 3, 2026 18:42
fad50e3 to
b22c9d6
Compare
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.
Motivation
The MCP binding requires
meta["idempotency-key"]oncomplete_checkoutandcancel_checkout"for retry safety", but it does not state the server-sideidempotency contract. That contract is only spelled out in the REST binding
(Specific Header Requirements: store the key, return the cached result on a
matching retry,
409on a mismatched reuse) and in the overview error registry(
409→-32000).An implementer building the MCP transport therefore has to cross-reference the
REST binding to learn how the server must behave on retries and key reuse. This
came up while implementing the checkout MCP binding: the requirement is
derivable, but not stated where an MCP-only reader would look.
What this PR changes
checkout-mcp.md- adds a short### Idempotencysubsection underProtocol Fundamentals (right after Request Metadata) that states the server's
idempotency contract for the MCP transport by reference to the REST binding
and the overview error registry, rather than restating it (to avoid a second
source of truth that could drift).
No normative change: this documents behavior the spec already requires.
Category (Required)
ucp-schematool (resolver, linter, validator). (Requires Maintainer approval)Related Issues
None.
Checklist
!for breaking changes).