mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 23:29:10 +02:00
ef4afe4061Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>
113 lines
3.7 KiB
Text
113 lines
3.7 KiB
Text
---
|
|
title: tool_manager
|
|
sidebarTitle: tool_manager
|
|
---
|
|
|
|
# `fastmcp.tools.tool_manager`
|
|
|
|
## Classes
|
|
|
|
### `ToolManager` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L23" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Manages FastMCP tools.
|
|
|
|
|
|
**Methods:**
|
|
|
|
#### `has_tool` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
has_tool(self, key: str) -> bool
|
|
```
|
|
|
|
Check if a tool exists.
|
|
|
|
|
|
#### `get_tool` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L61" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_tool(self, key: str) -> Tool
|
|
```
|
|
|
|
Get tool by key.
|
|
|
|
|
|
#### `get_tools` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L68" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_tools(self) -> dict[str, Tool]
|
|
```
|
|
|
|
Gets the complete, unfiltered inventory of local tools.
|
|
|
|
|
|
#### `add_tool_from_fn` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L74" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
add_tool_from_fn(self, fn: Callable[..., Any], name: str | None = None, description: str | None = None, tags: set[str] | None = None, annotations: ToolAnnotations | None = None, serializer: Callable[[Any], str] | None = None, exclude_args: list[str] | None = None) -> Tool
|
|
```
|
|
|
|
Add a tool to the server.
|
|
|
|
|
|
#### `add_tool` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L103" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
add_tool(self, tool: Tool) -> Tool
|
|
```
|
|
|
|
Register a tool with the server.
|
|
|
|
|
|
#### `add_tool_transformation` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L120" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
add_tool_transformation(self, tool_name: str, transformation: ToolTransformConfig) -> None
|
|
```
|
|
|
|
Add a tool transformation.
|
|
|
|
|
|
#### `get_tool_transformation` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L126" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
get_tool_transformation(self, tool_name: str) -> ToolTransformConfig | None
|
|
```
|
|
|
|
Get a tool transformation.
|
|
|
|
|
|
#### `remove_tool_transformation` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L130" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
remove_tool_transformation(self, tool_name: str) -> None
|
|
```
|
|
|
|
Remove a tool transformation.
|
|
|
|
|
|
#### `remove_tool` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L135" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
remove_tool(self, key: str) -> None
|
|
```
|
|
|
|
Remove a tool from the server.
|
|
|
|
**Args:**
|
|
- `key`: The key of the tool to remove
|
|
|
|
**Raises:**
|
|
- `NotFoundError`: If the tool is not found
|
|
|
|
|
|
#### `call_tool` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/tools/tool_manager.py#L149" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
call_tool(self, key: str, arguments: dict[str, Any]) -> ToolResult
|
|
```
|
|
|
|
Internal API for servers: Finds and calls a tool, respecting the
|
|
filtered protocol path.
|
|
|