mkdocs.yml

site_name: OpenIntent SDK
site_description: "The Python SDK for structured multi-agent coordination. 23 RFCs. Decorator-first agents. Built-in server. Federation. MCP integration."
site_url: https://openintent-ai.github.io/openintent/
repo_url: https://github.com/openintent-ai/openintent
repo_name: openintent-ai/openintent
edit_uri: edit/main/reference-implementation/docs/

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  icon:
    repo: fontawesome/brands/github
    logo: material/vector-polygon
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.expand
    - navigation.top
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
    - header.autohide
    - announce.dismiss

plugins:
  - search:
      separator: '[\s\-\.]+'
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - 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.snippets
  - pymdownx.mark
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: "#"
      toc_depth: 3

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - LLM Quick Start: getting-started/llm-quickstart.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - Intents: guide/intents.md
    - Events: guide/events.md
    - Leasing & Concurrency: guide/leasing.md
    - Governance & Arbitration: guide/governance.md
    - Attachments: guide/attachments.md
    - Subscriptions & Streaming: guide/subscriptions.md
    - Portfolios: guide/portfolios.md
    - Cost Tracking & Retry: guide/cost-retry.md
    - Access Control: guide/access-control.md
    - Task Planning: guide/task-planning.md
    - Coordinator Patterns: guide/coordinators.md
    - Credential Vaults & Tools: guide/vaults.md
    - Agent Memory: guide/memory.md
    - Agent Lifecycle & Health: guide/lifecycle.md
    - Triggers & Reactive Scheduling: guide/triggers.md
    - Cryptographic Identity: guide/cryptographic-identity.md
    - Verifiable Event Logs: guide/verifiable-logs.md
    - Distributed Tracing: guide/distributed-tracing.md
    - Agent-to-Agent Messaging: guide/messaging.md
    - Federation: guide/federation.md
    - MCP Integration: guide/mcp.md
    - YAML Workflows: guide/workflows.md
    - Agent Abstractions: guide/agents.md
    - LLM-Powered Agents: guide/llm-agents.md
    - LLM Adapters: guide/adapters.md
    - Built-in Server: guide/server.md
  - API Reference:
    - Client: api/client.md
    - Models: api/models.md
    - Workflow: api/workflow.md
    - Agents: api/agents.md
    - Adapters: api/adapters.md
    - Server: api/server.md
    - Federation: api/federation.md
    - Exceptions: api/exceptions.md
  - Specification:
    - Workflow YAML: spec/workflow-yaml.md
  - RFCs:
    - "0001 \u2014 Intent Objects": rfcs/0001-intent-objects.md
    - "0002 \u2014 Intent Graphs": rfcs/0002-intent-graphs.md
    - "0003 \u2014 Agent Leasing": rfcs/0003-agent-leasing.md
    - "0004 \u2014 Governance & Arbitration": rfcs/0004-governance-arbitration.md
    - "0005 \u2014 Attachments": rfcs/0005-attachments.md
    - "0006 \u2014 Subscriptions": rfcs/0006-subscriptions.md
    - "0007 \u2014 Intent Portfolios": rfcs/0007-intent-portfolios.md
    - "0008 \u2014 LLM Integration": rfcs/0008-llm-integration.md
    - "0009 \u2014 Cost Tracking": rfcs/0009-cost-tracking.md
    - "0010 \u2014 Retry Policies": rfcs/0010-retry-policies.md
    - "0011 \u2014 Access Control": rfcs/0011-access-control.md
    - "0012 \u2014 Task Decomposition": rfcs/0012-task-decomposition-planning.md
    - "0013 \u2014 Coordinator Governance": rfcs/0013-coordinator-governance.md
    - "0014 \u2014 Credential Vaults": rfcs/0014-credential-vaults-tool-scoping.md
    - "0015 \u2014 Agent Memory": rfcs/0015-agent-memory-persistent-state.md
    - "0016 \u2014 Agent Lifecycle": rfcs/0016-agent-lifecycle-health.md
    - "0017 \u2014 Triggers": rfcs/0017-triggers-reactive-scheduling.md
    - "0018 \u2014 Cryptographic Identity": rfcs/0018-cryptographic-agent-identity.md
    - "0019 \u2014 Verifiable Event Logs": rfcs/0019-verifiable-event-logs.md
    - "0020 \u2014 Distributed Tracing": rfcs/0020-distributed-tracing.md
    - "0021 \u2014 Agent-to-Agent Messaging": rfcs/0021-agent-to-agent-messaging.md
    - "0022 \u2014 Federation Protocol": rfcs/0022-federation-protocol.md
    - "0023 \u2014 Federation Security": rfcs/0023-federation-security.md
  - Changelog: changelog.md
  - Examples:
    - Multi-Agent Workflow: examples/multi-agent.md
    - Decorator-First Agents: examples/decorator-agents.md
    - Coordinator Patterns: examples/coordinators.md
    - Intent Lifecycle: examples/intent-lifecycle.md
    - Leasing & Concurrency: examples/leasing-concurrency.md
    - Governance & Arbitration: examples/governance-arbitration.md
    - LLM-Powered Agents: examples/llm-agents.md
    - LLM Adapters: examples/llm-adapters.md
    - Task Planning: examples/task-planning.md
    - Credential Vaults: examples/credential-vaults.md
    - Agent Memory: examples/agent-memory.md
    - Agent Lifecycle: examples/agent-lifecycle.md
    - Triggers: examples/triggers.md
    - Cryptographic Identity: examples/cryptographic-identity.md
    - Verifiable Event Logs: examples/verifiable-logs.md
    - Distributed Tracing: examples/distributed-tracing.md
    - Cost & Retry: examples/cost-retry.md
    - SSE & Streaming: examples/subscriptions-streaming.md
    - YAML Workflows: examples/yaml-workflows.md
    - Agent-to-Agent Messaging: examples/messaging.md
    - MCP Integration: examples/mcp.md
    - Federation: examples/federation.md
    - Server & Deployment: examples/server-deployment.md
    - Portfolios: examples/portfolios.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/openintent-ai/openintent
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/openintent/
  version:
    provider: mike
  announcement: "<strong>v0.15.1</strong> is here &mdash; Gemini adapter rebuilt for google-genai SDK v1.0+, full LLMEngine Gemini integration. <a href='changelog/'>Read the changelog &rarr;</a>"
  meta:
    - name: description
      content: "OpenIntent Python SDK — structured multi-agent coordination protocol with decorator-first agents, 23 RFCs, 7 LLM adapters, federation, MCP integration, and built-in FastAPI server."
    - name: og:title
      content: "OpenIntent SDK — Multi-Agent Coordination Protocol"
    - name: og:description
      content: "Production-ready Python SDK for structured multi-agent coordination. Decorator-first agents, YAML workflows, 7 LLM adapters, MCP integration, built-in server."
    - name: og:type
      content: website
    - name: og:url
      content: https://openintent-ai.github.io/openintent/
    - name: twitter:card
      content: summary_large_image
    - name: twitter:title
      content: "OpenIntent SDK"
    - name: twitter:description
      content: "The Python SDK for structured multi-agent coordination. 23 RFCs. Decorator-first agents. Federation. MCP integration. Built-in server."

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js