fastmcp.utilities.inspect

Utilities for inspecting FastMCP instances.

Functions

inspect_fastmcp_v2 ^{<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>}

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 ^{<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>}

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 ^{<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>}

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 ^{<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>}

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 ^{<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>}

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 ^{<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>}

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 ^{<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>}

Information about a tool.

PromptInfo ^{<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>}

Information about a prompt.

ResourceInfo ^{<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>}

Information about a resource.

TemplateInfo ^{<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>}

Information about a resource template.

FastMCPInfo ^{<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>}

Information extracted from a FastMCP instance.

InspectFormat ^{<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>}

Output format for inspect command.