Skip to content

docs: fix dev server command in README (#848) #859

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
wants to merge 4 commits into
base: main
Choose a base branch
from
+12 −12
Open

docs: fix dev server command in README (#848) #859

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7ef5ef4
docs: fix dev server command in README (#848)
Lasdw6 May 30, 2025
82d94b6
docs: prefix all mcp commands with ‘uv run’ in README (#848)
Lasdw6 Jun 2, 2025
64098e1
Merge branch 'modelcontextprotocol:main' into docs/fix-readme-848
Lasdw6 Jun 2, 2025
7e9dbd4
Merge branch 'main' into docs/fix-readme-848
Lasdw6 Jun 7, 2025
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
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,12 @@ def get_greeting(name: str) -> str:

You can install this server in [Claude Desktop](https://claude.ai/download) and interact with it right away by running:
```bash
mcp install server.py
uv run mcp install server.py
```

Alternatively, you can test it with the MCP Inspector:
```bash
mcp dev server.py
uv run mcp dev server.py
```

## What is MCP?
Expand Down Expand Up @@ -359,28 +359,28 @@ See [OAuthAuthorizationServerProvider](src/mcp/server/auth/provider.py) for more
The fastest way to test and debug your server is with the MCP Inspector:

```bash
mcp dev server.py
uv run mcp dev server.py

# Add dependencies
mcp dev server.py --with pandas --with numpy
uv run mcp dev server.py --with pandas --with numpy

# Mount local code
mcp dev server.py --with-editable .
uv run mcp dev server.py --with-editable .
```

### Claude Desktop Integration

Once your server is ready, install it in Claude Desktop:

```bash
mcp install server.py
uv run mcp install server.py

# Custom name
mcp install server.py --name "My Analytics Server"
uv run mcp install server.py --name "My Analytics Server"

# Environment variables
mcp install server.py -v API_KEY=abc123 -v DB_URL=postgres://...
mcp install server.py -f .env
uv run mcp install server.py -v API_KEY=abc123 -v DB_URL=postgres://...
uv run mcp install server.py -f .env
```

### Direct Execution
Expand All @@ -400,10 +400,10 @@ Run it with:
```bash
python server.py
# or
mcp run server.py
uv run mcp run server.py
```

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

### Streamable HTTP Transport

Expand Down Expand Up @@ -719,7 +719,7 @@ if __name__ == "__main__":
asyncio.run(run())
```

Caution: The `mcp run` and `mcp dev` tool doesn't support low-level server.
Caution: The `uv run mcp run` and `uv run mcp dev` tool doesn't support low-level server.

### Writing MCP Clients

Expand Down
Loading