From e4a3ed7ae66e8b3a8005597f13ed2461466f991a Mon Sep 17 00:00:00 2001 From: Rudrendu Date: Thu, 9 Apr 2026 00:46:40 -0700 Subject: [PATCH 1/2] docs: add CLI reference table for mcp dev/run/install flags Github-Issue: #457 --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 487d48bee..bb2208586 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,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) @@ -1241,6 +1242,43 @@ uv run mcp run servers/direct_execution.py Note that `uv run mcp run` or `uv run mcp dev` only supports server using FastMCP and not the low-level server variant. +### CLI Reference + +A complete reference for all `mcp` CLI commands and their flags. + +#### `mcp dev ` + +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 ` + +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 ` + +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. From 87a064f435640eac3f3cfb2dcf173011482fd9f0 Mon Sep 17 00:00:00 2001 From: Rudrendu Date: Thu, 9 Apr 2026 00:53:21 -0700 Subject: [PATCH 2/2] docs: add CLI reference table for mcp dev/run/install flags Github-Issue: #457 --- README.md | 38 -------------------------------------- README.v2.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index bb2208586..487d48bee 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,6 @@ - [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) @@ -1242,43 +1241,6 @@ uv run mcp run servers/direct_execution.py Note that `uv run mcp run` or `uv run mcp dev` only supports server using FastMCP and not the low-level server variant. -### CLI Reference - -A complete reference for all `mcp` CLI commands and their flags. - -#### `mcp dev ` - -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 ` - -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 ` - -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. diff --git a/README.v2.md b/README.v2.md index 55d867586..c6f4c5716 100644 --- a/README.v2.md +++ b/README.v2.md @@ -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) @@ -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 ` + +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 ` + +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 ` + +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.