turbomcp/mkdocs.yml at main · theahaco/turbomcp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# TurboMCP Documentation Site
# Built with Material for MkDocs

site_name: TurboMCP
site_url: https://turbomcp.dev
site_author: TurboMCP Contributors
site_description: >-
  Production-ready Rust SDK for the Model Context Protocol (MCP).
  Build MCP servers with zero-boilerplate, automatic schema generation,
  and full support for tools, resources, prompts, sampling, and elicitation.

# Repository
repo_name: turbomcp/turbomcp
repo_url: https://github.com/turbomcp/turbomcp

# Copyright
copyright: Copyright &copy; 2024 - 2026 TurboMCP Contributors

# Configuration
theme:
  name: material
  custom_dir: docs/overrides

  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to light mode

  font:
    text: Roboto
    code: Roboto Mono

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - meta
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic:
      mode: accept
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - tables
  - toc:
      permalink: true

plugins:
  - search:
      lang:
        - en

nav:
  - Home: index.md

  - Getting Started:
    - Overview: getting-started/overview.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Your First Server: getting-started/first-server.md

  - Guide:
    - Architecture: guide/architecture.md
    - Handlers: guide/handlers.md
    - Context & DI: guide/context-injection.md
    - Transports: guide/transports.md
    - Error Handling: guide/error-handling.md
    - Authentication: guide/authentication.md
    - Observability: guide/observability.md
    - Tower Middleware: guide/tower-middleware.md
    - Wire Codecs: guide/wire-codecs.md
    - WASM & Edge: guide/wasm.md
    - Advanced Patterns: guide/advanced-patterns.md

  - API Reference:
    - Protocol: api/protocol.md
    - Core Types: api/core.md
    - Server Framework: api/server.md
    - Client: api/client.md
    - Macros: api/macros.md
    - Wire Codecs: api/wire.md
    - gRPC Transport: api/grpc.md
    - WASM Bindings: api/wasm.md
    - Telemetry: api/telemetry.md
    - Utilities: api/utilities.md

  - Examples:
    - Basic Examples: examples/basic.md
    - Real-World Patterns: examples/patterns.md
    - Sampling & Elicitation: examples/advanced.md

  - Deployment:
    - Docker: deployment/docker.md
    - Production Setup: deployment/production.md
    - Edge & WASM: deployment/edge.md
    - Monitoring: deployment/monitoring.md

  - Architecture Deep Dives:
    - System Design: architecture/system-design.md
    - Context Lifecycle: architecture/context-lifecycle.md
    - Dependency Injection: architecture/dependency-injection.md
    - Protocol Compliance: architecture/protocol-compliance.md
    - v3 Migration: architecture/v3-migration.md

  - Contributing:
    - Code of Conduct: contributing/code-of-conduct.md
    - Development: contributing/development.md
    - Documentation: contributing/documentation.md

# Social icons
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/turbomcp/turbomcp
      name: GitHub
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/turbomcp
      name: Twitter
    - icon: fontawesome/solid/book
      link: https://docs.rs/turbomcp
      name: API Docs