forked from modelcontextprotocol/python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmkdocs.yml
More file actions
107 lines (101 loc) · 3.1 KB
/
mkdocs.yml
File metadata and controls
107 lines (101 loc) · 3.1 KB
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
site_name: ETDI Documentation
site_url: https://python-sdk-etdi.github.io/
theme:
name: material
palette:
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to light mode
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to dark mode
nav:
- Home: index.md
- ETDI Concepts: etdi-concepts.md
- Getting Started: getting-started.md
- Attack Prevention:
- Overview: attack-prevention.md
- Tool Poisoning: attack-prevention/tool-poisoning.md
- Rug Poisoning: attack-prevention/rug-poisoning.md
- Security Features: security-features.md
- Examples:
- Overview: examples/index.md
- ETDI Core Examples: examples/etdi/index.md
- FastMCP Integration: fastmcp/index.md
- Tool Poisoning Demo: examples/etdi/tool_poisoning_demo.md
# Individual ETDI Examples (add more as needed or keep them under ETDI Core Examples index)
- Basic ETDI Usage: examples/etdi/basic_usage.md
- E2E Demo: examples/etdi/run_e2e_demo.md
- API Reference: api.md
# TODO(Marcelo): Add Anthropic copyright?
# copyright: © Model Context Protocol 2025 to present
repo_name: modelcontextprotocol/python-sdk
repo_url: https://github.com/modelcontextprotocol/python-sdk
edit_uri: edit/main/docs/
# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
markdown_extensions:
- tables
- admonition
- attr_list
- md_in_html
- pymdownx.details
- pymdownx.caret
- pymdownx.critic
- pymdownx.mark
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.tilde
- pymdownx.inlinehilite
- pymdownx.highlight:
pygments_lang_class: true
- pymdownx.extra:
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- docs/.overrides/.icons
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- sane_lists # this means you can start a list from any number
watch:
- src/mcp
plugins:
- search
- social
- glightbox
- mkdocstrings:
handlers:
python:
paths: [src/mcp]
options:
relative_crossrefs: true
members_order: source
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
group_by_category: false
# 3 because docs are in pages with an H2 just above them
heading_level: 3
inventories:
- url: https://docs.python.org/3/objects.inv
- url: https://docs.pydantic.dev/latest/objects.inv
- url: https://typing-extensions.readthedocs.io/en/latest/objects.inv