zzstoatzz commited on
Commit
e526bb1
·
1 Parent(s): 8df8205

fix escaping problem

Browse files
docs/python-sdk/fastmcp-cli-claude.mdx CHANGED
@@ -30,7 +30,7 @@ update_claude_config(file_spec: str, server_name: str) -> bool
30
  Add or update a FastMCP server in Claude's configuration.
31
 
32
  **Args:**
33
- - `file_spec`: Path to the server file, optionally with :object suffix
34
  - `server_name`: Name for the server in Claude's config
35
  - `with_editable`: Optional directory to install in editable mode
36
  - `with_packages`: Optional list of additional packages to install
 
30
  Add or update a FastMCP server in Claude's configuration.
31
 
32
  **Args:**
33
+ - `file_spec`: Path to the server file, optionally with \:object suffix
34
  - `server_name`: Name for the server in Claude's config
35
  - `with_editable`: Optional directory to install in editable mode
36
  - `with_packages`: Optional list of additional packages to install
docs/python-sdk/fastmcp-cli-run.mdx CHANGED
@@ -30,7 +30,7 @@ parse_file_path(server_spec: str) -> tuple[Path, str | None]
30
  Parse a file path that may include a server object specification.
31
 
32
  **Args:**
33
- - `server_spec`: Path to file, optionally with :object suffix
34
 
35
  **Returns:**
36
  - Tuple of (file_path, server_object)
@@ -47,7 +47,7 @@ Import a MCP server from a file.
47
 
48
  **Args:**
49
  - `file`: Path to the file
50
- - `server_object`: Optional object name in format "module:object" or just "object"
51
 
52
  **Returns:**
53
  - The server object
@@ -97,7 +97,7 @@ run_command(server_spec: str, transport: str | None = None, host: str | None = N
97
  Run a MCP server or connect to a remote one.
98
 
99
  **Args:**
100
- - `server_spec`: Python file, object specification (file:obj), or URL
101
  - `transport`: Transport protocol to use
102
  - `host`: Host to bind to when using http transport
103
  - `port`: Port to bind to when using http transport
 
30
  Parse a file path that may include a server object specification.
31
 
32
  **Args:**
33
+ - `server_spec`: Path to file, optionally with \:object suffix
34
 
35
  **Returns:**
36
  - Tuple of (file_path, server_object)
 
47
 
48
  **Args:**
49
  - `file`: Path to the file
50
+ - `server_object`: Optional object name in format "module\:object" or just "object"
51
 
52
  **Returns:**
53
  - The server object
 
97
  Run a MCP server or connect to a remote one.
98
 
99
  **Args:**
100
+ - `server_spec`: Python file, object specification (file\:obj), or URL
101
  - `transport`: Transport protocol to use
102
  - `host`: Host to bind to when using http transport
103
  - `port`: Port to bind to when using http transport
docs/python-sdk/fastmcp-client-auth-oauth.mdx CHANGED
@@ -26,8 +26,7 @@ This is intended to be provided to the `auth` parameter of an
26
  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
 
26
  httpx.AsyncClient (or appropriate FastMCP client/transport instance)
27
 
28
  **Args:**
29
+ - `mcp_url`: Full URL to the MCP endpoint (e.g. "http\://host/mcp/sse/")
 
30
  - `scopes`: OAuth scopes to request. Can be a
31
  - `client_name`: Name for this client during registration
32
  - `token_storage_cache_dir`: Directory for FileTokenStorage
docs/python-sdk/fastmcp-server-server.mdx CHANGED
@@ -223,7 +223,7 @@ This decorator supports multiple calling patterns:
223
  - `name`: Optional name for the tool (keyword-only, alternative to name_or_fn)
224
  - `description`: Optional description of what the tool does
225
  - `tags`: Optional set of tags for categorizing the tool
226
- - `annotations`: Optional annotations about the tool's behavior (e.g. {"is_async": True})
227
  - `exclude_args`: Optional list of argument names to exclude from the tool schema
228
  - `enabled`: Optional boolean to enable or disable the tool
229
 
@@ -294,7 +294,7 @@ If the URI contains parameters (e.g. "resource://{param}") or the function
294
  has parameters, it will be registered as a template resource.
295
 
296
  **Args:**
297
- - `uri`: URI for the resource (e.g. "resource://my-resource" or "resource://{param}")
298
  - `name`: Optional name for the resource
299
  - `description`: Optional description of the resource
300
  - `mime_type`: Optional MIME type for the resource
 
223
  - `name`: Optional name for the tool (keyword-only, alternative to name_or_fn)
224
  - `description`: Optional description of what the tool does
225
  - `tags`: Optional set of tags for categorizing the tool
226
+ - `annotations`: Optional annotations about the tool's behavior (e.g. {"is_async"\: True})
227
  - `exclude_args`: Optional list of argument names to exclude from the tool schema
228
  - `enabled`: Optional boolean to enable or disable the tool
229
 
 
294
  has parameters, it will be registered as a template resource.
295
 
296
  **Args:**
297
+ - `uri`: URI for the resource (e.g. "resource\://my-resource" or "resource\://{param}")
298
  - `name`: Optional name for the resource
299
  - `description`: Optional description of the resource
300
  - `mime_type`: Optional MIME type for the resource
docs/python-sdk/fastmcp-tools-tool_transform.mdx CHANGED
@@ -89,10 +89,10 @@ to call the parent tool. Functions with **kwargs receive transformed
89
  argument names.
90
  - `name`: New name for the tool. Defaults to parent tool's name.
91
  - `transform_args`: Optional transformations for parent tool arguments.
92
- Only specified arguments are transformed, others pass through unchanged:
93
- - str: Simple rename
94
- - ArgTransform: Complex transformation (rename/description/default/drop)
95
- - None: Drop the argument
96
  - `description`: New description. Defaults to parent's description.
97
  - `tags`: New tags. Defaults to parent's tags.
98
  - `annotations`: New annotations. Defaults to parent's annotations.
 
89
  argument names.
90
  - `name`: New name for the tool. Defaults to parent tool's name.
91
  - `transform_args`: Optional transformations for parent tool arguments.
92
+ Only specified arguments are transformed, others pass through unchanged\:
93
+ - str\: Simple rename
94
+ - ArgTransform\: Complex transformation (rename/description/default/drop)
95
+ - None\: Drop the argument
96
  - `description`: New description. Defaults to parent's description.
97
  - `tags`: New tags. Defaults to parent's tags.
98
  - `annotations`: New annotations. Defaults to parent's annotations.
docs/python-sdk/fastmcp-utilities-json_schema.mdx CHANGED
@@ -20,6 +20,6 @@ Remove the given parameters from the schema.
20
  - `schema`: The schema to compress
21
  - `prune_params`: List of parameter names to remove from properties
22
  - `prune_defs`: Whether to remove unused definitions
23
- - `prune_additional_properties`: Whether to remove additionalProperties: false
24
  - `prune_titles`: Whether to remove title fields from the schema
25
 
 
20
  - `schema`: The schema to compress
21
  - `prune_params`: List of parameter names to remove from properties
22
  - `prune_defs`: Whether to remove unused definitions
23
+ - `prune_additional_properties`: Whether to remove additionalProperties\: false
24
  - `prune_titles`: Whether to remove title fields from the schema
25
 
justfile CHANGED
@@ -16,11 +16,11 @@ docs:
16
 
17
  # Generate API reference documentation for all modules
18
  api-ref-all:
19
- uv run --with-editable . --with mdxify@latest 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 mdxify@latest mdxify {{MODULES}} --root-module fastmcp --anchor-name "SDK Reference"
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
+ uvx --with-editable . --refresh-package mdxify mdxify@latest --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
+ uvx --with-editable . --refresh-package mdxify mdxify@latest {{MODULES}} --root-module fastmcp --anchor-name "SDK Reference"
24
 
25
  # Clean up API reference documentation
26
  api-ref-clean: