FilesExpand file tree

v1.x

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

140 lines (131 loc) · 3.86 KB

v1.x

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

140 lines (131 loc) · 3.86 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

site_name: MCP Python SDK

site_description: The official Python SDK for the Model Context Protocol

strict: true

repo_name: modelcontextprotocol/python-sdk

repo_url: https://github.com/modelcontextprotocol/python-sdk

edit_uri: edit/v1.x/docs/

site_url: https://py.sdk.modelcontextprotocol.io/v1/

# TODO(Marcelo): Add Anthropic copyright?

# copyright: © Model Context Protocol 2025 to present

nav:

- Introduction: index.md

- Installation: installation.md

- Documentation:

- Building Servers: server.md

- Writing Clients: client.md

- Protocol Features: protocol.md

- Low-Level Server: low-level-server.md

- Authorization: authorization.md

- Testing: testing.md

- Experimental:

- Overview: experimental/index.md

- Tasks:

- Introduction: experimental/tasks.md

- Server Implementation: experimental/tasks-server.md

- Client Usage: experimental/tasks-client.md

- API Reference: api.md

theme:

name: "material"

palette:

- media: "(prefers-color-scheme)"

scheme: default

primary: black

accent: black

toggle:

icon: material/lightbulb

name: "Switch to light mode"

- media: "(prefers-color-scheme: light)"

scheme: default

primary: black

accent: black

toggle:

icon: material/lightbulb-outline

name: "Switch to dark mode"

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: white

accent: white

toggle:

icon: material/lightbulb-auto-outline

name: "Switch to system preference"

features:

- search.suggest

- search.highlight

- content.tabs.link

- content.code.annotate

- content.code.copy

- content.code.select

- navigation.path

- navigation.indexes

- navigation.sections

- navigation.tracking

- toc.follow

# logo: "img/logo-white.svg"

# TODO(Marcelo): Add a favicon.

# favicon: "favicon.ico"

# 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

# Resolve snippet includes against the repo root regardless of the build's

# working directory (the extension's default base_path is the CWD).

- pymdownx.snippets:

base_path: !relative $config_dir

- 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

hooks:

- docs/hooks/llms_txt.py

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

import:

- 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