Jeremiah Lowin commited on
Commit
f9c77fe
·
unverified ·
2 Parent(s): 7c60ea806baf65

Merge pull request #913 from jlowin/docs-org

Browse files
Files changed (1) hide show
  1. docs/docs.json +190 -179
docs/docs.json CHANGED
@@ -44,224 +44,235 @@
44
  }
45
  },
46
  "navigation": {
47
- "anchors": [
48
  {
49
- "anchor": "Documentation",
50
- "groups": [
51
  {
52
- "group": "Get Started",
53
- "pages": [
54
- "getting-started/welcome",
55
- "getting-started/installation",
56
- "getting-started/quickstart"
57
- ]
58
- },
59
- {
60
- "group": "What's New",
61
- "pages": ["updates", "changelog"]
62
- },
63
- {
64
- "group": "Servers",
65
- "pages": [
66
- "servers/server",
67
  {
68
- "group": "Core Components",
69
- "icon": "toolbox",
70
  "pages": [
71
- "servers/tools",
72
- "servers/resources",
73
- "servers/prompts",
74
- "servers/context"
75
  ]
76
  },
77
  {
78
- "group": "Authentication",
79
- "icon": "shield-check",
80
- "pages": ["servers/auth/bearer"]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
81
  },
82
- "servers/middleware",
83
- "servers/openapi",
84
- "servers/proxy",
85
- "servers/composition",
86
  {
87
- "group": "Deployment",
88
- "icon": "upload",
89
- "pages": ["deployment/running-server", "deployment/asgi"]
90
- }
91
- ]
92
- },
93
- {
94
- "group": "Clients",
95
- "pages": [
96
- "clients/client",
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
97
  {
98
- "group": "Core Operations",
99
- "icon": "handshake",
100
  "pages": [
101
- "clients/tools",
102
- "clients/resources",
103
- "clients/prompts"
 
 
104
  ]
105
  },
106
  {
107
- "group": "Advanced Features",
108
- "icon": "stars",
109
  "pages": [
110
- "clients/logging",
111
- "clients/progress",
112
- "clients/sampling",
113
- "clients/roots"
 
114
  ]
115
  },
116
- "clients/transports",
117
  {
118
- "group": "Authentication",
119
- "icon": "user-shield",
120
- "pages": ["clients/auth/oauth", "clients/auth/bearer"]
 
 
 
121
  }
122
- ]
123
- },
124
- {
125
- "group": "Integrations",
126
- "pages": [
127
- "integrations/anthropic",
128
- "integrations/claude-desktop",
129
- "integrations/openai",
130
- "integrations/gemini",
131
- "integrations/contrib"
132
- ]
133
  },
134
  {
135
- "group": "Patterns",
136
- "pages": [
137
- "patterns/tool-transformation",
138
- "patterns/decorating-methods",
139
- "patterns/http-requests",
140
- "patterns/testing",
141
- "patterns/cli"
142
- ]
143
  },
 
144
  {
145
- "group": "Tutorials",
146
- "pages": [
147
- "tutorials/mcp",
148
- "tutorials/create-mcp-server",
149
- "tutorials/rest-api"
150
- ]
151
  }
152
- ],
153
- "icon": "book"
154
- },
155
- {
156
- "anchor": "Community",
157
- "icon": "users",
158
- "pages": ["community/showcase"]
159
  },
160
  {
161
- "anchor": "SDK Reference",
162
- "icon": "code",
163
- "pages": [
164
- "python-sdk/fastmcp-exceptions",
165
- "python-sdk/fastmcp-settings",
166
  {
167
- "group": "fastmcp.cli",
 
168
  "pages": [
169
- "python-sdk/fastmcp-cli-__init__",
170
- "python-sdk/fastmcp-cli-claude",
171
- "python-sdk/fastmcp-cli-cli",
172
- "python-sdk/fastmcp-cli-run"
173
- ]
174
- },
175
- {
176
- "group": "fastmcp.client",
177
- "pages": [
178
- "python-sdk/fastmcp-client-__init__",
179
  {
180
- "group": "auth",
181
  "pages": [
182
- "python-sdk/fastmcp-client-auth-__init__",
183
- "python-sdk/fastmcp-client-auth-bearer",
184
- "python-sdk/fastmcp-client-auth-oauth"
 
185
  ]
186
  },
187
- "python-sdk/fastmcp-client-client",
188
- "python-sdk/fastmcp-client-logging",
189
- "python-sdk/fastmcp-client-oauth_callback",
190
- "python-sdk/fastmcp-client-progress",
191
- "python-sdk/fastmcp-client-roots",
192
- "python-sdk/fastmcp-client-sampling",
193
- "python-sdk/fastmcp-client-transports"
194
- ]
195
- },
196
- {
197
- "group": "fastmcp.prompts",
198
- "pages": [
199
- "python-sdk/fastmcp-prompts-__init__",
200
- "python-sdk/fastmcp-prompts-prompt",
201
- "python-sdk/fastmcp-prompts-prompt_manager"
202
- ]
203
- },
204
- {
205
- "group": "fastmcp.resources",
206
- "pages": [
207
- "python-sdk/fastmcp-resources-__init__",
208
- "python-sdk/fastmcp-resources-resource",
209
- "python-sdk/fastmcp-resources-resource_manager",
210
- "python-sdk/fastmcp-resources-template",
211
- "python-sdk/fastmcp-resources-types"
212
- ]
213
- },
214
- {
215
- "group": "fastmcp.server",
216
- "pages": [
217
- "python-sdk/fastmcp-server-__init__",
218
  {
219
- "group": "auth",
220
  "pages": [
221
- "python-sdk/fastmcp-server-auth-__init__",
222
- "python-sdk/fastmcp-server-auth-auth",
223
  {
224
- "group": "providers",
225
  "pages": [
226
- "python-sdk/fastmcp-server-auth-providers-__init__",
227
- "python-sdk/fastmcp-server-auth-providers-bearer",
228
- "python-sdk/fastmcp-server-auth-providers-bearer_env",
229
- "python-sdk/fastmcp-server-auth-providers-in_memory"
230
  ]
231
- }
 
 
 
 
 
 
 
232
  ]
233
  },
234
- "python-sdk/fastmcp-server-context",
235
- "python-sdk/fastmcp-server-dependencies",
236
- "python-sdk/fastmcp-server-http",
237
- "python-sdk/fastmcp-server-middleware",
238
- "python-sdk/fastmcp-server-openapi",
239
- "python-sdk/fastmcp-server-proxy",
240
- "python-sdk/fastmcp-server-server"
241
- ]
242
- },
243
- {
244
- "group": "fastmcp.tools",
245
- "pages": [
246
- "python-sdk/fastmcp-tools-__init__",
247
- "python-sdk/fastmcp-tools-tool",
248
- "python-sdk/fastmcp-tools-tool_manager",
249
- "python-sdk/fastmcp-tools-tool_transform"
250
- ]
251
- },
252
- {
253
- "group": "fastmcp.utilities",
254
- "pages": [
255
- "python-sdk/fastmcp-utilities-__init__",
256
- "python-sdk/fastmcp-utilities-cache",
257
- "python-sdk/fastmcp-utilities-components",
258
- "python-sdk/fastmcp-utilities-exceptions",
259
- "python-sdk/fastmcp-utilities-http",
260
- "python-sdk/fastmcp-utilities-json_schema",
261
- "python-sdk/fastmcp-utilities-logging",
262
- "python-sdk/fastmcp-utilities-mcp_config",
263
- "python-sdk/fastmcp-utilities-openapi",
264
- "python-sdk/fastmcp-utilities-types"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
265
  ]
266
  }
267
  ]
 
44
  }
45
  },
46
  "navigation": {
47
+ "tabs": [
48
  {
49
+ "tab": "Documentation",
50
+ "anchors": [
51
  {
52
+ "anchor": "Documentation",
53
+ "groups": [
 
 
 
 
 
 
 
 
 
 
 
 
 
54
  {
55
+ "group": "Get Started",
 
56
  "pages": [
57
+ "getting-started/welcome",
58
+ "getting-started/installation",
59
+ "getting-started/quickstart"
 
60
  ]
61
  },
62
  {
63
+ "group": "Servers",
64
+ "pages": [
65
+ "servers/server",
66
+ {
67
+ "group": "Core Components",
68
+ "icon": "toolbox",
69
+ "pages": [
70
+ "servers/tools",
71
+ "servers/resources",
72
+ "servers/prompts",
73
+ "servers/context"
74
+ ]
75
+ },
76
+ {
77
+ "group": "Authentication",
78
+ "icon": "shield-check",
79
+ "pages": ["servers/auth/bearer"]
80
+ },
81
+ "servers/middleware",
82
+ "servers/openapi",
83
+ "servers/proxy",
84
+ "servers/composition",
85
+ {
86
+ "group": "Deployment",
87
+ "icon": "upload",
88
+ "pages": ["deployment/running-server", "deployment/asgi"]
89
+ }
90
+ ]
91
  },
 
 
 
 
92
  {
93
+ "group": "Clients",
94
+ "pages": [
95
+ "clients/client",
96
+ {
97
+ "group": "Core Operations",
98
+ "icon": "handshake",
99
+ "pages": [
100
+ "clients/tools",
101
+ "clients/resources",
102
+ "clients/prompts"
103
+ ]
104
+ },
105
+ {
106
+ "group": "Advanced Features",
107
+ "icon": "stars",
108
+ "pages": [
109
+ "clients/logging",
110
+ "clients/progress",
111
+ "clients/sampling",
112
+ "clients/roots"
113
+ ]
114
+ },
115
+ "clients/transports",
116
+ {
117
+ "group": "Authentication",
118
+ "icon": "user-shield",
119
+ "pages": ["clients/auth/oauth", "clients/auth/bearer"]
120
+ }
121
+ ]
122
+ },
123
  {
124
+ "group": "Integrations",
 
125
  "pages": [
126
+ "integrations/anthropic",
127
+ "integrations/claude-desktop",
128
+ "integrations/openai",
129
+ "integrations/gemini",
130
+ "integrations/contrib"
131
  ]
132
  },
133
  {
134
+ "group": "Patterns",
 
135
  "pages": [
136
+ "patterns/tool-transformation",
137
+ "patterns/decorating-methods",
138
+ "patterns/http-requests",
139
+ "patterns/testing",
140
+ "patterns/cli"
141
  ]
142
  },
 
143
  {
144
+ "group": "Tutorials",
145
+ "pages": [
146
+ "tutorials/mcp",
147
+ "tutorials/create-mcp-server",
148
+ "tutorials/rest-api"
149
+ ]
150
  }
151
+ ],
152
+ "icon": "book"
 
 
 
 
 
 
 
 
 
153
  },
154
  {
155
+ "anchor": "What's New",
156
+ "pages": ["updates", "changelog"]
 
 
 
 
 
 
157
  },
158
+
159
  {
160
+ "anchor": "Community",
161
+ "icon": "users",
162
+ "pages": ["community/showcase"]
 
 
 
163
  }
164
+ ]
 
 
 
 
 
 
165
  },
166
  {
167
+ "tab": "SDK Reference",
168
+ "anchors": [
 
 
 
169
  {
170
+ "anchor": "Python SDK",
171
+ "icon": "python",
172
  "pages": [
173
+ "python-sdk/fastmcp-exceptions",
174
+ "python-sdk/fastmcp-settings",
 
 
 
 
 
 
 
 
175
  {
176
+ "group": "fastmcp.cli",
177
  "pages": [
178
+ "python-sdk/fastmcp-cli-__init__",
179
+ "python-sdk/fastmcp-cli-claude",
180
+ "python-sdk/fastmcp-cli-cli",
181
+ "python-sdk/fastmcp-cli-run"
182
  ]
183
  },
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
184
  {
185
+ "group": "fastmcp.client",
186
  "pages": [
187
+ "python-sdk/fastmcp-client-__init__",
 
188
  {
189
+ "group": "auth",
190
  "pages": [
191
+ "python-sdk/fastmcp-client-auth-__init__",
192
+ "python-sdk/fastmcp-client-auth-bearer",
193
+ "python-sdk/fastmcp-client-auth-oauth"
 
194
  ]
195
+ },
196
+ "python-sdk/fastmcp-client-client",
197
+ "python-sdk/fastmcp-client-logging",
198
+ "python-sdk/fastmcp-client-oauth_callback",
199
+ "python-sdk/fastmcp-client-progress",
200
+ "python-sdk/fastmcp-client-roots",
201
+ "python-sdk/fastmcp-client-sampling",
202
+ "python-sdk/fastmcp-client-transports"
203
  ]
204
  },
205
+ {
206
+ "group": "fastmcp.prompts",
207
+ "pages": [
208
+ "python-sdk/fastmcp-prompts-__init__",
209
+ "python-sdk/fastmcp-prompts-prompt",
210
+ "python-sdk/fastmcp-prompts-prompt_manager"
211
+ ]
212
+ },
213
+ {
214
+ "group": "fastmcp.resources",
215
+ "pages": [
216
+ "python-sdk/fastmcp-resources-__init__",
217
+ "python-sdk/fastmcp-resources-resource",
218
+ "python-sdk/fastmcp-resources-resource_manager",
219
+ "python-sdk/fastmcp-resources-template",
220
+ "python-sdk/fastmcp-resources-types"
221
+ ]
222
+ },
223
+ {
224
+ "group": "fastmcp.server",
225
+ "pages": [
226
+ "python-sdk/fastmcp-server-__init__",
227
+ {
228
+ "group": "auth",
229
+ "pages": [
230
+ "python-sdk/fastmcp-server-auth-__init__",
231
+ "python-sdk/fastmcp-server-auth-auth",
232
+ {
233
+ "group": "providers",
234
+ "pages": [
235
+ "python-sdk/fastmcp-server-auth-providers-__init__",
236
+ "python-sdk/fastmcp-server-auth-providers-bearer",
237
+ "python-sdk/fastmcp-server-auth-providers-bearer_env",
238
+ "python-sdk/fastmcp-server-auth-providers-in_memory"
239
+ ]
240
+ }
241
+ ]
242
+ },
243
+ "python-sdk/fastmcp-server-context",
244
+ "python-sdk/fastmcp-server-dependencies",
245
+ "python-sdk/fastmcp-server-http",
246
+ "python-sdk/fastmcp-server-middleware",
247
+ "python-sdk/fastmcp-server-openapi",
248
+ "python-sdk/fastmcp-server-proxy",
249
+ "python-sdk/fastmcp-server-server"
250
+ ]
251
+ },
252
+ {
253
+ "group": "fastmcp.tools",
254
+ "pages": [
255
+ "python-sdk/fastmcp-tools-__init__",
256
+ "python-sdk/fastmcp-tools-tool",
257
+ "python-sdk/fastmcp-tools-tool_manager",
258
+ "python-sdk/fastmcp-tools-tool_transform"
259
+ ]
260
+ },
261
+ {
262
+ "group": "fastmcp.utilities",
263
+ "pages": [
264
+ "python-sdk/fastmcp-utilities-__init__",
265
+ "python-sdk/fastmcp-utilities-cache",
266
+ "python-sdk/fastmcp-utilities-components",
267
+ "python-sdk/fastmcp-utilities-exceptions",
268
+ "python-sdk/fastmcp-utilities-http",
269
+ "python-sdk/fastmcp-utilities-json_schema",
270
+ "python-sdk/fastmcp-utilities-logging",
271
+ "python-sdk/fastmcp-utilities-mcp_config",
272
+ "python-sdk/fastmcp-utilities-openapi",
273
+ "python-sdk/fastmcp-utilities-types"
274
+ ]
275
+ }
276
  ]
277
  }
278
  ]