zzstoatzz commited on
Commit
e978c13
·
1 Parent(s): 3159d8c

fix rendering for some pages

Browse files
docs/docs.json CHANGED
@@ -177,9 +177,11 @@
177
  {
178
  "group": "fastmcp.client",
179
  "pages": [
 
180
  {
181
  "group": "auth",
182
  "pages": [
 
183
  "python-sdk/fastmcp-client-auth-bearer",
184
  "python-sdk/fastmcp-client-auth-oauth"
185
  ]
@@ -196,6 +198,7 @@
196
  {
197
  "group": "fastmcp.prompts",
198
  "pages": [
 
199
  "python-sdk/fastmcp-prompts-prompt",
200
  "python-sdk/fastmcp-prompts-prompt_manager"
201
  ]
@@ -203,6 +206,7 @@
203
  {
204
  "group": "fastmcp.resources",
205
  "pages": [
 
206
  "python-sdk/fastmcp-resources-resource",
207
  "python-sdk/fastmcp-resources-resource_manager",
208
  "python-sdk/fastmcp-resources-template",
@@ -212,13 +216,16 @@
212
  {
213
  "group": "fastmcp.server",
214
  "pages": [
 
215
  {
216
  "group": "auth",
217
  "pages": [
 
218
  "python-sdk/fastmcp-server-auth-auth",
219
  {
220
  "group": "providers",
221
  "pages": [
 
222
  "python-sdk/fastmcp-server-auth-providers-bearer",
223
  "python-sdk/fastmcp-server-auth-providers-bearer_env",
224
  "python-sdk/fastmcp-server-auth-providers-in_memory"
@@ -238,6 +245,7 @@
238
  {
239
  "group": "fastmcp.tools",
240
  "pages": [
 
241
  "python-sdk/fastmcp-tools-tool",
242
  "python-sdk/fastmcp-tools-tool_manager",
243
  "python-sdk/fastmcp-tools-tool_transform"
 
177
  {
178
  "group": "fastmcp.client",
179
  "pages": [
180
+ "python-sdk/fastmcp-client-__init__",
181
  {
182
  "group": "auth",
183
  "pages": [
184
+ "python-sdk/fastmcp-client-auth-__init__",
185
  "python-sdk/fastmcp-client-auth-bearer",
186
  "python-sdk/fastmcp-client-auth-oauth"
187
  ]
 
198
  {
199
  "group": "fastmcp.prompts",
200
  "pages": [
201
+ "python-sdk/fastmcp-prompts-__init__",
202
  "python-sdk/fastmcp-prompts-prompt",
203
  "python-sdk/fastmcp-prompts-prompt_manager"
204
  ]
 
206
  {
207
  "group": "fastmcp.resources",
208
  "pages": [
209
+ "python-sdk/fastmcp-resources-__init__",
210
  "python-sdk/fastmcp-resources-resource",
211
  "python-sdk/fastmcp-resources-resource_manager",
212
  "python-sdk/fastmcp-resources-template",
 
216
  {
217
  "group": "fastmcp.server",
218
  "pages": [
219
+ "python-sdk/fastmcp-server-__init__",
220
  {
221
  "group": "auth",
222
  "pages": [
223
+ "python-sdk/fastmcp-server-auth-__init__",
224
  "python-sdk/fastmcp-server-auth-auth",
225
  {
226
  "group": "providers",
227
  "pages": [
228
+ "python-sdk/fastmcp-server-auth-providers-__init__",
229
  "python-sdk/fastmcp-server-auth-providers-bearer",
230
  "python-sdk/fastmcp-server-auth-providers-bearer_env",
231
  "python-sdk/fastmcp-server-auth-providers-in_memory"
 
245
  {
246
  "group": "fastmcp.tools",
247
  "pages": [
248
+ "python-sdk/fastmcp-tools-__init__",
249
  "python-sdk/fastmcp-tools-tool",
250
  "python-sdk/fastmcp-tools-tool_manager",
251
  "python-sdk/fastmcp-tools-tool_transform"
docs/python-sdk/fastmcp-client-auth-oauth.mdx CHANGED
@@ -27,7 +27,7 @@ httpx.AsyncClient (or appropriate FastMCP client/transport instance)
27
 
28
  **Args:**
29
  - `mcp_url`: Full URL to the MCP endpoint (e.g.,
30
- - `"http`: //host/mcp/sse")
31
  - `scopes`: OAuth scopes to request. Can be a
32
  - `client_name`: Name for this client during registration
33
  - `token_storage_cache_dir`: Directory for FileTokenStorage
 
27
 
28
  **Args:**
29
  - `mcp_url`: Full URL to the MCP endpoint (e.g.,
30
+ - `"http`: //host/mcp/sse/")
31
  - `scopes`: OAuth scopes to request. Can be a
32
  - `client_name`: Name for this client during registration
33
  - `token_storage_cache_dir`: Directory for FileTokenStorage
docs/python-sdk/fastmcp-server-auth-providers-bearer.mdx CHANGED
@@ -38,7 +38,7 @@ Generate an RSA key pair for testing.
38
  #### `create_token`
39
 
40
  ```python
41
- create_token(self, subject: str = 'fastmcp-user', issuer: str = 'https://fastmcp.example.com', audience: str | None = None, scopes: list[str] | None = None, expires_in_seconds: int = 3600, additional_claims: dict[str, Any] | None = None, kid: str | None = None) -> str
42
  ```
43
 
44
  Generate a test JWT token for testing purposes.
@@ -47,7 +47,7 @@ Generate a test JWT token for testing purposes.
47
  - `private_key_pem`: RSA private key in PEM format
48
  - `subject`: Subject claim (usually user ID)
49
  - `issuer`: Issuer claim
50
- - `audience`: Audience claim (optional)
51
  - `scopes`: List of scopes to include
52
  - `expires_in_seconds`: Token expiration time in seconds
53
  - `additional_claims`: Any additional claims to include
 
38
  #### `create_token`
39
 
40
  ```python
41
+ create_token(self, subject: str = 'fastmcp-user', issuer: str = 'https://fastmcp.example.com', audience: str | list[str] | None = None, scopes: list[str] | None = None, expires_in_seconds: int = 3600, additional_claims: dict[str, Any] | None = None, kid: str | None = None) -> str
42
  ```
43
 
44
  Generate a test JWT token for testing purposes.
 
47
  - `private_key_pem`: RSA private key in PEM format
48
  - `subject`: Subject claim (usually user ID)
49
  - `issuer`: Issuer claim
50
+ - `audience`: Audience claim - can be a string or list of strings (optional)
51
  - `scopes`: List of scopes to include
52
  - `expires_in_seconds`: Token expiration time in seconds
53
  - `additional_claims`: Any additional claims to include
justfile CHANGED
@@ -16,11 +16,11 @@ docs:
16
 
17
  # Generate API reference documentation for all modules
18
  api-ref-all:
19
- uvx --with-editable . --refresh-package mdxify mdxify@latest --all --root-module fastmcp
20
 
21
  # Generate API reference for specific modules (e.g., just api-ref prefect.flows prefect.tasks)
22
  api-ref *MODULES:
23
- uvx --with-editable . --refresh-package mdxify mdxify@latest {{MODULES}} --root-module fastmcp
24
 
25
  # Clean up API reference documentation
26
  api-ref-clean:
 
16
 
17
  # Generate API reference documentation for all modules
18
  api-ref-all:
19
+ uv run --with-editable . --with git+https://github.com/zzstoatzz/mdxify.git@fix-navigation-structure mdxify --all --root-module fastmcp --anchor-name "SDK Reference"
20
 
21
  # Generate API reference for specific modules (e.g., just api-ref prefect.flows prefect.tasks)
22
  api-ref *MODULES:
23
+ uv run --with-editable . --with git+https://github.com/zzstoatzz/mdxify.git@fix-navigation-structure mdxify {{MODULES}} --root-module fastmcp --anchor-name "SDK Reference"
24
 
25
  # Clean up API reference documentation
26
  api-ref-clean: