mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 15:19:10 +02:00
149a7aa2ce* docs: align CLI and deployment docs Generated with Codex. * docs: restore install config support, fix CIMD placeholder, add missing CLI flags * docs: restore contrib guidance, correct --copy availability * docs: remove dead redirect-shadowed pages * Fix stale --path default in run command help * docs: correct Goose flag support, fix README link to moved testing page --------- Co-authored-by: Jeremiah Lowin <153965+jlowin@users.noreply.github.com>
77 lines
2.6 KiB
Text
77 lines
2.6 KiB
Text
---
|
|
title: Inspecting Servers
|
|
sidebarTitle: Inspecting
|
|
description: View a server's components and metadata
|
|
icon: magnifying-glass
|
|
---
|
|
|
|
import { VersionBadge } from '/snippets/version-badge.mdx'
|
|
|
|
<VersionBadge version="2.9.0" />
|
|
|
|
`fastmcp inspect` loads a server and reports what it contains — its tools, resources, prompts, version, and metadata. The default output is a human-readable summary:
|
|
|
|
```bash
|
|
fastmcp inspect server.py
|
|
```
|
|
|
|
```
|
|
Server: MyServer
|
|
Instructions: A helpful MCP server
|
|
Version: 1.0.0
|
|
|
|
Components:
|
|
Tools: 5
|
|
Prompts: 2
|
|
Resources: 3
|
|
Templates: 1
|
|
|
|
Environment:
|
|
FastMCP: 2.0.0
|
|
MCP: 1.0.0
|
|
|
|
Use --format [fastmcp|mcp] for complete JSON output
|
|
```
|
|
|
|
## JSON Output
|
|
|
|
For programmatic use, two JSON formats are available:
|
|
|
|
**FastMCP format** (`--format fastmcp`) includes everything FastMCP knows about the server — tool tags, enabled status, output schemas, annotations, and custom metadata. Field names use `snake_case`. This is the format for debugging and introspecting FastMCP servers.
|
|
|
|
**MCP protocol format** (`--format mcp`) shows exactly what MCP clients see through the protocol — only standard MCP fields, `camelCase` names, no FastMCP-specific extensions. This is the format for verifying client compatibility and debugging what clients actually receive.
|
|
|
|
```bash
|
|
# Full FastMCP metadata to stdout
|
|
fastmcp inspect server.py --format fastmcp
|
|
|
|
# MCP protocol view saved to file
|
|
fastmcp inspect server.py --format mcp -o manifest.json
|
|
```
|
|
|
|
## Options
|
|
|
|
| Option | Flag | Description |
|
|
| ------ | ---- | ----------- |
|
|
| Format | `--format`, `-f` | `fastmcp` or `mcp` (required when using `-o`) |
|
|
| Output File | `--output`, `-o` | Save to file instead of stdout |
|
|
| Python | `--python` | Python version to use when running via `uv` |
|
|
| Extra Packages | `--with` | Additional packages to install (repeatable) |
|
|
| Project | `--project` | Run within a specific uv project directory |
|
|
| Requirements | `--with-requirements` | Install from a requirements file |
|
|
| Skip Env | `--skip-env` | Do not set up a uv environment |
|
|
|
|
## Entrypoints
|
|
|
|
The `inspect` command supports the same local entrypoints as [`fastmcp run`](/cli/running): inferred instances, explicit entrypoints, factory functions, and `fastmcp.json` configs.
|
|
|
|
```bash
|
|
fastmcp inspect server.py # inferred instance
|
|
fastmcp inspect server.py:my_server # explicit entrypoint
|
|
fastmcp inspect server.py:create_server # factory function
|
|
fastmcp inspect fastmcp.json # config file
|
|
```
|
|
|
|
<Warning>
|
|
`inspect` only works with local files and `fastmcp.json` — it doesn't connect to remote URLs or standard MCP config files.
|
|
</Warning>
|