Skip to content

docs(mcp): align checkout/order bindings with cart-mcp pattern#444

Open
sakinaroufid wants to merge 4 commits into
Universal-Commerce-Protocol:mainfrom
sakinaroufid:docs/mcp-render-consistency
Open

docs(mcp): align checkout/order bindings with cart-mcp pattern#444
sakinaroufid wants to merge 4 commits into
Universal-Commerce-Protocol:mainfrom
sakinaroufid:docs/mcp-render-consistency

Conversation

@sakinaroufid
Copy link
Copy Markdown
Contributor

Description

Three render-consistency fixes for the MCP transport docs. Brings checkout-mcp.md and order-mcp.md in line with patterns cart-mcp.md has been using since #128.

  1. checkout-mcp.md: replace inline schema bullets with {{ schema_fields(...) }} in per-operation Input/Output Schema sections. The hand-maintained field lists had drifted from the schemas.

  2. checkout-mcp.md and order-mcp.md: drop the meta line from per-operation Input Schemas. It's documented once per file in "Request Metadata" under "Protocol Fundamentals".

  3. order-mcp.md: add the protocol-errors-vs-business-outcomes bullets to Error Handling. This prose was added to cart-mcp.md and checkout-mcp.md in feat(errors): spec error handling for UCP negotiation failures #128; order-mcp.md landed later (feat(order): Get Order operation w/ platform-auth #276) and missed the pattern. Points at the existing Not Found and Not Authorized tabs under get_order rather than inlining another copy of the same envelope.

Category (Required)

  • Documentation: Updates to README, or documentations regarding schema or capabilities. (Requires Maintainer approval)

Related Issues

None.

Checklist

  • I have followed the Contributing Guide (including Conventional Commits title requirements and ! for breaking changes).
  • I have updated the documentation (if applicable).
  • My changes pass all local linting and formatting checks.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • (For Core/Capability) I have included/updated the relevant JSON schemas.
  • I have regenerated Python Pydantic models by running generate_models.sh under python_sdk.

Screenshots / Logs (if applicable)

Will add before/after screenshots of the rendered order-mcp Error Handling section and one of the checkout-mcp Input/Output Schema sections once I have the local mkdocs preview rendered.

Three render-consistency fixes for the MCP transport docs.

- checkout-mcp.md: switch per-operation Input/Output Schema sections to
  schema_fields() macro. Cart-mcp.md already does this; the inline
  bullet lists in checkout-mcp.md had drifted from the schemas.
- checkout-mcp.md, order-mcp.md: drop redundant `meta` from per-op
  Input Schemas. It's documented once per file in "Request Metadata"
  under "Protocol Fundamentals".
- order-mcp.md: add the protocol-errors-vs-business-outcomes bullets to
  Error Handling. Cart-mcp.md and checkout-mcp.md got these in Universal-Commerce-Protocol#128 but
  order-mcp.md was added later (Universal-Commerce-Protocol#276) and missed the pattern. Points at
  the existing Not Found and Not Authorized tabs under get_order rather
  than inlining another copy of the same envelope.
@sakinaroufid sakinaroufid requested review from a team as code owners May 16, 2026 14:26
@sakinaroufid sakinaroufid requested review from archrao and kmcduffie May 16, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant