mcpygen/mkdocs.yml at main · gradion-ai/mcpygen · 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
site_name: mcpygen
site_description: MCP tooling infrastructure
site_url: https://gradion-ai.github.io/mcpygen/

repo_name: gradion-ai/mcpygen
repo_url: https://github.com/gradion-ai/mcpygen

copyright: Copyright &copy; 2025-2026 Gradion AI

theme:
  name: material
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    scheme: slate
    primary: custom
    accent: custom
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.top
    - navigation.tracking
    - search.suggest
    - toc.follow
    - content.code.copy
    - content.code.select
    - content.code.annotate

plugins:
  - search
  - llmstxt:
      markdown_description: |
        mcpygen generates typed Python APIs from MCP server tool schemas. Tool calls made through
        the generated APIs are executed on a local tool server that manages stdio MCP servers and
        connects to remote streamable HTTP or SSE servers, with optional approval workflows via
        WebSocket-based approval channels.
      full_output: llms-full.txt
      sections:
        User Guide:
          - index.md: Project overview and capabilities
          - installation.md: Installation and setup instructions
          - quickstart.md: Getting started guide
          - apigen.md: Generating typed Python APIs from MCP server schemas
          - toolserver.md: ToolServer
          - approval.md: Approval workflow
          - cli.md: CLI reference
        API Reference:
          - api/apigen.md: API generation
          - api/toolserver.md: ToolServer
          - api/toolrunner.md: ToolRunner
          - api/approval.md: Approval workflow
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [mcpygen]
          options:
            show_root_heading: true
            show_source: false
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true
            merge_init_into_class: true
            extensions:
              - griffe_pydantic
          inventories:
            - url: https://docs.python.org/3/objects.inv
              domains: [py, std]

markdown_extensions:
  - footnotes
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      dedent_subsections: true
  - pymdownx.superfences
  - pymdownx.details
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_css:
  - stylesheets/extra.css

nav:
  - Documentation:
    - Overview: index.md
    - Installation: installation.md
    - Quickstart: quickstart.md
    - API generation: apigen.md
    - Tool server: toolserver.md
    - Approval: approval.md
    - CLI: cli.md
    - LLM readable:
      - llms.txt: llms.txt
      - llms-full.txt: llms-full.txt
  - API Reference:
    - API generation: api/apigen.md
    - ToolServer: api/toolserver.md
    - ToolRunner: api/toolrunner.md
    - Approval: api/approval.md