mkdocs.yml

---
#   Copyright 2026 UCP Authors
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.


site_name: Universal Commerce Protocol (UCP)
site_url: !ENV [SITE_URL, "https://ucp.dev/"]  # Required for the llmstxt plugin to work.
site_description: >
  The Universal Commerce Protocol (UCP) is a solution for enabling gen AI agents
  to make payments on behalf of users, safely, securely, and in a decentralized
  and privacy protecting manner. This protocol is a part of the broader
  ecosystem, which includes agentic protocols like A2A and MCP, and encompasses
  the global nature of payments.
site_dir: site
edit_uri: edit/main/docs/

# Navigation
nav:
  - Overview:
      - Home: index.md
      - Core Concepts: documentation/core-concepts.md
      - Specification: !ENV [SPEC_URL, "https://ucp.dev/latest/specification/overview/"]
      - UCP and AP2: documentation/ucp-and-ap2.md
      - Roadmap: documentation/roadmap.md
      - Schema Authoring: documentation/schema-authoring.md
      - Versioning: versioning.md
  - Specification:
      - Overview: specification/overview.md
      - Checkout Capability:
          - Overview: specification/checkout.md
          - HTTP/REST Binding: specification/checkout-rest.md
          - MCP Binding: specification/checkout-mcp.md
          - A2A Binding: specification/checkout-a2a.md
          - EP Binding: specification/embedded-checkout.md
          - AP2 Mandates Extension: specification/ap2-mandates.md
          - Buyer Consent Extension: specification/buyer-consent.md
          - Discounts Extension: specification/discount.md
          - Fulfillment Extension: specification/fulfillment.md
      - Cart Capability:
          - Overview: specification/cart.md
          - HTTP/REST Binding: specification/cart-rest.md
          - MCP Binding: specification/cart-mcp.md
          - EP Binding: specification/embedded-cart.md
      - Catalog Capability:
          - Overview: specification/catalog/index.md
          - Search: specification/catalog/search.md
          - Lookup: specification/catalog/lookup.md
          - HTTP/REST Binding: specification/catalog/rest.md
          - MCP Binding: specification/catalog/mcp.md
      - Order Capability: specification/order.md
      - Identity Linking Capability: specification/identity-linking.md
      - Payment Handlers:
          - Guide: specification/payment-handler-guide.md
          - Template: specification/payment-handler-template.md
          - Tokenization Guide: specification/tokenization-guide.md
          - Examples:
              - Processor Tokenizer: specification/examples/processor-tokenizer-payment-handler.md
              - Platform Tokenizer: specification/examples/platform-tokenizer-payment-handler.md
              - Encrypted Credential: specification/examples/encrypted-credential-handler.md
      - Signatures: specification/signatures.md
      - Reference: specification/reference.md
      - Playground: specification/playground.md

repo_name: UCP on GitHub # Override repo name to be shorter on site header.
repo_url: https://github.com/Universal-Commerce-Protocol/ucp

# Copyright
copyright: Copyright 2026 UCP Authors. Licensed under the <a href="https://github.com/Universal-Commerce-Protocol/ucp/blob/main/LICENSE">Apache License, Version 2.0</a>.

# Custom CSS
extra_css:
  - stylesheets/custom.css

#Global Constants
extra:
  ucp_version: "draft"
  ucp_url: https://ucp.dev
  analytics:
    provider: google
    # cSpell:disable
    property: G-ZEGTBCTMJ9
    # cSpell:enable
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  scope: /
  version:
    provider: mike

# Configuration
theme:
  logo: assets/updated-icon.svg
  favicon: assets/favicon.png
  name: material
  font:
    text: Google Sans
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
    view: material/pencil-box-multiple
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
  palette:
    - scheme: default
      primary: white
      accent: indigo
    - scheme: slate
      primary: black
      accent: indigo
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    # - navigation.expand
    - navigation.footer
    # - navigation.indexes
    # - navigation.instant
    # - navigation.instant.progress
    # - navigation.path
    - navigation.top
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - toc.follow

# Extensions
markdown_extensions:
  - meta
  - footnotes
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: .
      url_download: true
      dedent_subsections: true
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

# Custom hooks
hooks:
  - hooks.py

# Plugins
plugins:
  - search
  - macros:
      on_error_fail: true
  - site-urls
  - social
  - llmstxt:
      full_output: llms-full.txt
      sections:
        Overview:
          - index.md
          - documentation/core-concepts.md
          - documentation/ucp-and-ap2.md
          - documentation/roadmap.md
          - documentation/schema-authoring.md
          - versioning.md
        Specification:
          - specification/overview.md
        Message Signatures:
          - specification/signatures.md
        Checkout Capability:
          - specification/checkout.md
          - specification/checkout-rest.md
          - specification/checkout-mcp.md
          - specification/checkout-a2a.md
          - specification/embedded-checkout.md
          - specification/ap2-mandates.md
          - specification/buyer-consent.md
          - specification/discount.md
          - specification/fulfillment.md
        Cart Capability:
          - specification/cart.md
          - specification/cart-rest.md
          - specification/cart-mcp.md
          - specification/embedded-cart.md
        Catalog Capability:
          - specification/catalog/index.md
          - specification/catalog/search.md
          - specification/catalog/lookup.md
          - specification/catalog/rest.md
          - specification/catalog/mcp.md
        Other Capabilities:
          - specification/order.md
          - specification/identity-linking.md
          - specification/payment-handler-guide.md
          - specification/payment-handler-template.md
          - specification/tokenization-guide.md
          - specification/examples/processor-tokenizer-payment-handler.md
          - specification/examples/platform-tokenizer-payment-handler.md
          - specification/examples/encrypted-credential-handler.md
          - specification/reference.md
          - specification/playground.md