Skip to content

docs: add CLI reference table for mcp dev/run/install flags #2409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RudrenduPaul wants to merge 3 commits into
base: main
Choose a base branch
from
+38 −0
Open

docs: add CLI reference table for mcp dev/run/install flags #2409

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4a3ed7
docs: add CLI reference table for mcp dev/run/install flags
RudrenduPaul Apr 9, 2026
87a064f
docs: add CLI reference table for mcp dev/run/install flags
RudrenduPaul Apr 9, 2026
d12f547
Merge branch 'main' into docs/add-cli-reference-table
RudrenduPaul Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
- [Development Mode](#development-mode)
- [Claude Desktop Integration](#claude-desktop-integration)
- [Direct Execution](#direct-execution)
- [CLI Reference](#cli-reference)
- [Streamable HTTP Transport](#streamable-http-transport)
- [CORS Configuration for Browser-Based Clients](#cors-configuration-for-browser-based-clients)
- [Mounting to an Existing ASGI Server](#mounting-to-an-existing-asgi-server)
Expand Down Expand Up @@ -1232,6 +1233,43 @@ uv run mcp run servers/direct_execution.py

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

### CLI Reference

A complete reference for all `mcp` CLI commands and their flags.

#### `mcp dev <file_spec>`

Run an MCP server with the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) for interactive testing and debugging.

| Flag | Short | Type | Description |
| -------------------- | ----- | ------ | ----------------------------------------------------------------- |
| `--with-editable` | `-e` | `PATH` | Directory containing `pyproject.toml` to install in editable mode |
| `--with` | | `TEXT` | Additional packages to install (repeatable) |

#### `mcp run <file_spec>`

Run an MCP server directly. The server can be specified as a module (`server.py`) or with an explicit object path (`server.py:app`).

| Flag | Short | Type | Description |
| --------------- | ----- | ------------- | -------------------------------------------- |
| `--transport` | `-t` | `stdio\|sse` | Transport protocol to use (default: `stdio`) |

#### `mcp install <file_spec>`

Install an MCP server in the Claude Desktop app. Environment variables are preserved once set and only updated when new values are explicitly provided.

| Flag | Short | Type | Description |
| -------------------- | ----- | ----------- | ----------------------------------------------------------------- |
| `--name` | `-n` | `TEXT` | Custom name for the server (defaults to file name) |
| `--with-editable` | `-e` | `PATH` | Directory containing `pyproject.toml` to install in editable mode |
| `--with` | | `TEXT` | Additional packages to install (repeatable) |
| `--env-var` | `-v` | `KEY=VALUE` | Environment variables in `KEY=VALUE` format (repeatable) |
| `--env-file` | `-f` | `PATH` | Load environment variables from a `.env` file |

#### `mcp version`

Print the installed MCP SDK version.

### Streamable HTTP Transport

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