Skip to content

Commit 82d94b6

Browse files
committed
docs: prefix all mcp commands with ‘uv run’ in README (#848)
1 parent 7ef5ef4 commit 82d94b6

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ def get_greeting(name: str) -> str:
129129

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

135135
Alternatively, you can test it with the MCP Inspector:
@@ -359,28 +359,28 @@ See [OAuthAuthorizationServerProvider](src/mcp/server/auth/provider.py) for more
359359
The fastest way to test and debug your server is with the MCP Inspector:
360360

361361
```bash
362-
mcp dev server.py
362+
uv run mcp dev server.py
363363

364364
# Add dependencies
365-
mcp dev server.py --with pandas --with numpy
365+
uv run mcp dev server.py --with pandas --with numpy
366366

367367
# Mount local code
368-
mcp dev server.py --with-editable .
368+
uv run mcp dev server.py --with-editable .
369369
```
370370

371371
### Claude Desktop Integration
372372

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

375375
```bash
376-
mcp install server.py
376+
uv run mcp install server.py
377377

378378
# Custom name
379-
mcp install server.py --name "My Analytics Server"
379+
uv run mcp install server.py --name "My Analytics Server"
380380

381381
# Environment variables
382-
mcp install server.py -v API_KEY=abc123 -v DB_URL=postgres://...
383-
mcp install server.py -f .env
382+
uv run mcp install server.py -v API_KEY=abc123 -v DB_URL=postgres://...
383+
uv run mcp install server.py -f .env
384384
```
385385

386386
### Direct Execution
@@ -400,10 +400,10 @@ Run it with:
400400
```bash
401401
python server.py
402402
# or
403-
mcp run server.py
403+
uv run mcp run server.py
404404
```
405405

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

408408
### Streamable HTTP Transport
409409

@@ -719,7 +719,7 @@ if __name__ == "__main__":
719719
asyncio.run(run())
720720
```
721721

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

724724
### Writing MCP Clients
725725

0 commit comments

Comments
 (0)