Skip to content

docs: add getting started guide for building UCP servers - #645

Draft
damaz91 wants to merge 9 commits into
mainfrom
docs-getting-started
Draft

docs: add getting started guide for building UCP servers#645
damaz91 wants to merge 9 commits into
mainfrom
docs-getting-started

Conversation

@damaz91

@damaz91 damaz91 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Description

This PR adds a new "Getting Started" section to the UCP documentation site (in the "Specification" section), providing a step-by-step guide for developers to build core UCP endpoints (Create Checkout and Get Checkout) using either the Python SDK (FastAPI) or the Node.js/TypeScript SDK (Express).

Key features of this guide:

  • Multi-language support with linked tabs for Python and Node.js.
  • Generic mock payment handler setup.
  • Step-by-step code snippets with detailed comments.
  • Coverage of header validation (Idempotency-Key, UCP-Agent).
  • Calculation of subtotal, tax, and total at both line item and order levels.
  • Information on next steps, including linking to the Conformance repository.

Category (Required)

  • Core Protocol: Changes to the base communication layer, global context, or breaking refactors. (Requires Technical Council approval)
  • Governance/Contributing: Updates to GOVERNANCE.md, CONTRIBUTING.md, or CODEOWNERS. (Requires Governance Council approval)
  • Capability: New schemas (Discovery, Cart, etc.) or extensions. (Requires Maintainer approval)
  • Documentation: Updates to README, or documentations regarding schema or capabilities. (Requires Maintainer approval)
  • Infrastructure: CI/CD, Linters, or build scripts. (Requires DevOps Maintainer approval)
  • Maintenance: Version bumps, lockfile updates, or minor bug fixes. (Requires DevOps Maintainer approval)
  • SDK: Language-specific SDK updates and releases. (Requires DevOps Maintainer approval)
  • Samples / Conformance: Maintaining samples and the conformance suite. (Requires Maintainer approval)
  • UCP Schema: Changes to the ucp-schema tool (resolver, linter, validator). (Requires Maintainer approval)
  • Community Health (.github): Updates to templates, workflows, or org-level configs. (Requires DevOps 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)

AhXWUvuK27jfdPg

@damaz91 damaz91 added the WIP label Jul 28, 2026
@damaz91
damaz91 force-pushed the docs-getting-started branch from ac31bbc to 0de8aed Compare July 29, 2026 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant