Skip to content

Commit 86f5679

Browse files
chore: Update SDK documentation
1 parent 7e6610b commit 86f5679

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/python-sdk/fastmcp-client-client.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ Retrieve a list of tools available on the server.
476476
#### `call_tool_mcp` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/client.py#L877" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
477477

478478
```python
479-
call_tool_mcp(self, name: str, arguments: dict[str, Any], progress_handler: ProgressHandler | None = None, timeout: datetime.timedelta | float | int | None = None) -> mcp.types.CallToolResult
479+
call_tool_mcp(self, name: str, arguments: dict[str, Any], progress_handler: ProgressHandler | None = None, timeout: datetime.timedelta | float | int | None = None, meta: dict[str, Any] | None = None) -> mcp.types.CallToolResult
480480
```
481481

482482
Send a tools/call request and return the complete MCP protocol result.
@@ -489,6 +489,7 @@ and other metadata. It does not raise an exception if the tool call results in a
489489
- `arguments`: Arguments to pass to the tool.
490490
- `timeout`: The timeout for the tool call. Defaults to None.
491491
- `progress_handler`: The progress handler to use for the tool call. Defaults to None.
492+
- `meta`: Additional metadata to send with the tool call.
492493

493494
**Returns:**
494495
- mcp.types.CallToolResult: The complete response object from the protocol,
@@ -498,10 +499,10 @@ containing the tool result and any additional metadata.
498499
- `RuntimeError`: If called while the client is not connected.
499500

500501

501-
#### `call_tool` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/client.py#L915" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
502+
#### `call_tool` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/client.py#L919" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
502503

503504
```python
504-
call_tool(self, name: str, arguments: dict[str, Any] | None = None, timeout: datetime.timedelta | float | int | None = None, progress_handler: ProgressHandler | None = None, raise_on_error: bool = True) -> CallToolResult
505+
call_tool(self, name: str, arguments: dict[str, Any] | None = None, timeout: datetime.timedelta | float | int | None = None, progress_handler: ProgressHandler | None = None, raise_on_error: bool = True, meta: dict[str, Any] | None = None) -> CallToolResult
505506
```
506507

507508
Call a tool on the server.
@@ -513,6 +514,8 @@ Unlike call_tool_mcp, this method raises a ToolError if the tool call results in
513514
- `arguments`: Arguments to pass to the tool. Defaults to None.
514515
- `timeout`: The timeout for the tool call. Defaults to None.
515516
- `progress_handler`: The progress handler to use for the tool call. Defaults to None.
517+
- `raise_on_error`: Whether to raise a ToolError if the tool call results in an error. Defaults to True.
518+
- `meta`: Additional metadata to send with the tool call.
516519

517520
**Returns:**
518521
-
@@ -528,10 +531,10 @@ raw result object.
528531
- `RuntimeError`: If called while the client is not connected.
529532

530533

531-
#### `generate_name` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/client.py#L987" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
534+
#### `generate_name` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/client.py#L995" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
532535

533536
```python
534537
generate_name(cls, name: str | None = None) -> str
535538
```
536539

537-
### `CallToolResult` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/client.py#L996" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
540+
### `CallToolResult` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/client/client.py#L1004" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

0 commit comments

Comments
 (0)