mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 23:29:10 +02:00
9b248a15b3* Update repository references from jlowin/fastmcp to prefecthq/fastmcp * Retrigger CI after repo transfer * chore: Update SDK documentation * Only run deep triage on bug issues for jlowin --------- Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>
143 lines
4.5 KiB
Text
143 lines
4.5 KiB
Text
---
|
|
title: inspect
|
|
sidebarTitle: inspect
|
|
---
|
|
|
|
# `fastmcp.utilities.inspect`
|
|
|
|
|
|
Utilities for inspecting FastMCP instances.
|
|
|
|
## Functions
|
|
|
|
### `inspect_fastmcp_v2` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L100" 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/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L236" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
inspect_fastmcp_v1(mcp: FastMCP1x) -> 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/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L378" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
inspect_fastmcp(mcp: FastMCP[Any] | FastMCP1x) -> 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
|
|
|
|
|
|
### `format_fastmcp_info` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L403" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
format_fastmcp_info(info: FastMCPInfo) -> bytes
|
|
```
|
|
|
|
|
|
Format FastMCPInfo as FastMCP-specific JSON.
|
|
|
|
This includes FastMCP-specific fields like tags, enabled, annotations, etc.
|
|
|
|
|
|
### `format_mcp_info` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L432" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
format_mcp_info(mcp: FastMCP[Any] | FastMCP1x) -> bytes
|
|
```
|
|
|
|
|
|
Format server info as standard MCP protocol JSON.
|
|
|
|
Uses Client to get the standard MCP protocol format with camelCase fields.
|
|
Includes version metadata at the top level.
|
|
|
|
|
|
### `format_info` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L465" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
format_info(mcp: FastMCP[Any] | FastMCP1x, format: InspectFormat | Literal['fastmcp', 'mcp'], info: FastMCPInfo | None = None) -> bytes
|
|
```
|
|
|
|
|
|
Format server information according to the specified format.
|
|
|
|
**Args:**
|
|
- `mcp`: The FastMCP instance
|
|
- `format`: Output format ("fastmcp" or "mcp")
|
|
- `info`: Pre-extracted FastMCPInfo (optional, will be extracted if not provided)
|
|
|
|
**Returns:**
|
|
- JSON bytes in the requested format
|
|
|
|
|
|
## Classes
|
|
|
|
### `ToolInfo` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L19" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information about a tool.
|
|
|
|
|
|
### `PromptInfo` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L35" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information about a prompt.
|
|
|
|
|
|
### `ResourceInfo` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L49" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information about a resource.
|
|
|
|
|
|
### `TemplateInfo` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L65" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information about a resource template.
|
|
|
|
|
|
### `FastMCPInfo` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L82" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Information extracted from a FastMCP instance.
|
|
|
|
|
|
### `InspectFormat` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/utilities/inspect.py#L396" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
|
|
Output format for inspect command.
|
|
|