mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-20 12:34:17 +02:00
94 lines
2.8 KiB
Text
94 lines
2.8 KiB
Text
---
|
|
title: inspect
|
|
sidebarTitle: inspect
|
|
---
|
|
|
|
# `fastmcp.utilities.inspect`
|
|
|
|
|
|
Utilities for inspecting FastMCP instances.
|
|
|
|
## Functions
|
|
|
|
### `inspect_fastmcp_v2` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L82" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
inspect_fastmcp_v2(mcp: FastMCP[Any]) -> FastMCPInfo
|
|
```
|
|
|
|
|
|
Extract information from a FastMCP v2.x instance.
|
|
|
|
**Args:**
|
|
- `mcp`: The FastMCP v2.x instance to inspect
|
|
|
|
**Returns:**
|
|
- FastMCPInfo dataclass containing the extracted information
|
|
|
|
|
|
### `inspect_fastmcp_v1` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L182" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
inspect_fastmcp_v1(mcp: Any) -> FastMCPInfo
|
|
```
|
|
|
|
|
|
Extract information from a FastMCP v1.x instance using a Client.
|
|
|
|
**Args:**
|
|
- `mcp`: The FastMCP v1.x instance to inspect
|
|
|
|
**Returns:**
|
|
- FastMCPInfo dataclass containing the extracted information
|
|
|
|
|
|
### `inspect_fastmcp` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L311" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
inspect_fastmcp(mcp: FastMCP[Any] | Any) -> FastMCPInfo
|
|
```
|
|
|
|
|
|
Extract information from a FastMCP instance into a dataclass.
|
|
|
|
This function automatically detects whether the instance is FastMCP v1.x or v2.x
|
|
and uses the appropriate extraction method.
|
|
|
|
**Args:**
|
|
- `mcp`: The FastMCP instance to inspect (v1.x or v2.x)
|
|
|
|
**Returns:**
|
|
- FastMCPInfo dataclass containing the extracted information
|
|
|
|
|
|
## Classes
|
|
|
|
### `ToolInfo` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L16" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information about a tool.
|
|
|
|
|
|
### `PromptInfo` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L29" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information about a prompt.
|
|
|
|
|
|
### `ResourceInfo` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L41" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information about a resource.
|
|
|
|
|
|
### `TemplateInfo` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L54" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information about a resource template.
|
|
|
|
|
|
### `FastMCPInfo` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L67" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information extracted from a FastMCP instance.
|
|
|