Skip to content

Commit 87a064f

Browse files
author
Rudrendu
committed
docs: add CLI reference table for mcp dev/run/install flags
Github-Issue: #457
1 parent e4a3ed7 commit 87a064f

File tree

2 files changed

+38
-38
lines changed

2 files changed

+38
-38
lines changed

README.md

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@
5353
- [Development Mode](#development-mode)
5454
- [Claude Desktop Integration](#claude-desktop-integration)
5555
- [Direct Execution](#direct-execution)
56-
- [CLI Reference](#cli-reference)
5756
- [Streamable HTTP Transport](#streamable-http-transport)
5857
- [CORS Configuration for Browser-Based Clients](#cors-configuration-for-browser-based-clients)
5958
- [Mounting to an Existing ASGI Server](#mounting-to-an-existing-asgi-server)
@@ -1242,43 +1241,6 @@ uv run mcp run servers/direct_execution.py
12421241

12431242
Note that `uv run mcp run` or `uv run mcp dev` only supports server using FastMCP and not the low-level server variant.
12441243

1245-
### CLI Reference
1246-
1247-
A complete reference for all `mcp` CLI commands and their flags.
1248-
1249-
#### `mcp dev <file_spec>`
1250-
1251-
Run an MCP server with the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) for interactive testing and debugging.
1252-
1253-
| Flag | Short | Type | Description |
1254-
|------|-------|------|-------------|
1255-
| `--with-editable` | `-e` | `PATH` | Directory containing `pyproject.toml` to install in editable mode |
1256-
| `--with` | | `TEXT` | Additional packages to install (repeatable) |
1257-
1258-
#### `mcp run <file_spec>`
1259-
1260-
Run an MCP server directly. The server can be specified as a module (`server.py`) or with an explicit object path (`server.py:app`).
1261-
1262-
| Flag | Short | Type | Description |
1263-
|------|-------|------|-------------|
1264-
| `--transport` | `-t` | `stdio\|sse` | Transport protocol to use (default: `stdio`) |
1265-
1266-
#### `mcp install <file_spec>`
1267-
1268-
Install an MCP server in the Claude Desktop app. Environment variables are preserved once set and only updated when new values are explicitly provided.
1269-
1270-
| Flag | Short | Type | Description |
1271-
|------|-------|------|-------------|
1272-
| `--name` | `-n` | `TEXT` | Custom name for the server (defaults to file name) |
1273-
| `--with-editable` | `-e` | `PATH` | Directory containing `pyproject.toml` to install in editable mode |
1274-
| `--with` | | `TEXT` | Additional packages to install (repeatable) |
1275-
| `--env-var` | `-v` | `KEY=VALUE` | Environment variables in `KEY=VALUE` format (repeatable) |
1276-
| `--env-file` | `-f` | `PATH` | Load environment variables from a `.env` file |
1277-
1278-
#### `mcp version`
1279-
1280-
Print the installed MCP SDK version.
1281-
12821244
### Streamable HTTP Transport
12831245

12841246
> **Note**: Streamable HTTP transport is the recommended transport for production deployments. Use `stateless_http=True` and `json_response=True` for optimal scalability.

README.v2.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
- [Development Mode](#development-mode)
5555
- [Claude Desktop Integration](#claude-desktop-integration)
5656
- [Direct Execution](#direct-execution)
57+
- [CLI Reference](#cli-reference)
5758
- [Streamable HTTP Transport](#streamable-http-transport)
5859
- [CORS Configuration for Browser-Based Clients](#cors-configuration-for-browser-based-clients)
5960
- [Mounting to an Existing ASGI Server](#mounting-to-an-existing-asgi-server)
@@ -1232,6 +1233,43 @@ uv run mcp run servers/direct_execution.py
12321233

12331234
Note that `uv run mcp run` or `uv run mcp dev` only supports server using MCPServer and not the low-level server variant.
12341235

1236+
### CLI Reference
1237+
1238+
A complete reference for all `mcp` CLI commands and their flags.
1239+
1240+
#### `mcp dev <file_spec>`
1241+
1242+
Run an MCP server with the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) for interactive testing and debugging.
1243+
1244+
| Flag | Short | Type | Description |
1245+
| -------------------- | ----- | ------ | ----------------------------------------------------------------- |
1246+
| `--with-editable` | `-e` | `PATH` | Directory containing `pyproject.toml` to install in editable mode |
1247+
| `--with` | | `TEXT` | Additional packages to install (repeatable) |
1248+
1249+
#### `mcp run <file_spec>`
1250+
1251+
Run an MCP server directly. The server can be specified as a module (`server.py`) or with an explicit object path (`server.py:app`).
1252+
1253+
| Flag | Short | Type | Description |
1254+
| --------------- | ----- | ------------- | -------------------------------------------- |
1255+
| `--transport` | `-t` | `stdio\|sse` | Transport protocol to use (default: `stdio`) |
1256+
1257+
#### `mcp install <file_spec>`
1258+
1259+
Install an MCP server in the Claude Desktop app. Environment variables are preserved once set and only updated when new values are explicitly provided.
1260+
1261+
| Flag | Short | Type | Description |
1262+
| -------------------- | ----- | ----------- | ----------------------------------------------------------------- |
1263+
| `--name` | `-n` | `TEXT` | Custom name for the server (defaults to file name) |
1264+
| `--with-editable` | `-e` | `PATH` | Directory containing `pyproject.toml` to install in editable mode |
1265+
| `--with` | | `TEXT` | Additional packages to install (repeatable) |
1266+
| `--env-var` | `-v` | `KEY=VALUE` | Environment variables in `KEY=VALUE` format (repeatable) |
1267+
| `--env-file` | `-f` | `PATH` | Load environment variables from a `.env` file |
1268+
1269+
#### `mcp version`
1270+
1271+
Print the installed MCP SDK version.
1272+
12351273
### Streamable HTTP Transport
12361274

12371275
> **Note**: Streamable HTTP transport is the recommended transport for production deployments. Use `stateless_http=True` and `json_response=True` for optimal scalability.

0 commit comments

Comments
 (0)