Spaces:
Running
Running
Jeremiah Lowin Claude commited on
Commit ·
909c8ea
1
Parent(s): 162c9ed
Update cli.mdx
Browse filesCo-Authored-By: Claude <noreply@anthropic.com>
- docs/patterns/cli.mdx +24 -0
docs/patterns/cli.mdx
CHANGED
|
@@ -21,6 +21,7 @@ fastmcp --help
|
|
| 21 |
| `run` | Run a FastMCP server directly | Uses your current environment; you are responsible for ensuring all dependencies are available |
|
| 22 |
| `dev` | Run a server with the MCP Inspector for testing | Creates an isolated environment; dependencies must be explicitly specified with `--with` and/or `--with-editable` |
|
| 23 |
| `install` | Install a server in the Claude desktop app | Creates an isolated environment; dependencies must be explicitly specified with `--with` and/or `--with-editable` |
|
|
|
|
| 24 |
| `version` | Display version information | N/A |
|
| 25 |
|
| 26 |
## Command Details
|
|
@@ -179,6 +180,29 @@ fastmcp install server.py:my_server
|
|
| 179 |
fastmcp install server.py:my_server -n "My Analysis Server" --with pandas
|
| 180 |
```
|
| 181 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 182 |
### `version`
|
| 183 |
|
| 184 |
Display version information about FastMCP and related components.
|
|
|
|
| 21 |
| `run` | Run a FastMCP server directly | Uses your current environment; you are responsible for ensuring all dependencies are available |
|
| 22 |
| `dev` | Run a server with the MCP Inspector for testing | Creates an isolated environment; dependencies must be explicitly specified with `--with` and/or `--with-editable` |
|
| 23 |
| `install` | Install a server in the Claude desktop app | Creates an isolated environment; dependencies must be explicitly specified with `--with` and/or `--with-editable` |
|
| 24 |
+
| `inspect` | Generate a JSON report about a FastMCP server | Uses your current environment; you are responsible for ensuring all dependencies are available |
|
| 25 |
| `version` | Display version information | N/A |
|
| 26 |
|
| 27 |
## Command Details
|
|
|
|
| 180 |
fastmcp install server.py:my_server -n "My Analysis Server" --with pandas
|
| 181 |
```
|
| 182 |
|
| 183 |
+
### `inspect`
|
| 184 |
+
|
| 185 |
+
<VersionBadge version="2.9.0" />
|
| 186 |
+
|
| 187 |
+
Generate a detailed JSON report about a FastMCP server, including information about its tools, prompts, resources, and capabilities.
|
| 188 |
+
|
| 189 |
+
```bash
|
| 190 |
+
fastmcp inspect server.py
|
| 191 |
+
```
|
| 192 |
+
|
| 193 |
+
The command supports the same server specification format as `run` and `install`:
|
| 194 |
+
|
| 195 |
+
```bash
|
| 196 |
+
# Auto-detect server object
|
| 197 |
+
fastmcp inspect server.py
|
| 198 |
+
|
| 199 |
+
# Specify server object
|
| 200 |
+
fastmcp inspect server.py:my_server
|
| 201 |
+
|
| 202 |
+
# Custom output location
|
| 203 |
+
fastmcp inspect server.py --output analysis.json
|
| 204 |
+
```
|
| 205 |
+
|
| 206 |
### `version`
|
| 207 |
|
| 208 |
Display version information about FastMCP and related components.
|