Skip to content

Commit 31076ab

Browse files
authored
docs: fix dev server command in README (#848) (#859)
1 parent 9301924 commit 31076ab

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -133,12 +133,12 @@ def get_greeting(name: str) -> str:
133133

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

139139
Alternatively, you can test it with the MCP Inspector:
140140
```bash
141-
mcp dev server.py
141+
uv run mcp dev server.py
142142
```
143143

144144
## What is MCP?
@@ -589,28 +589,28 @@ See [TokenVerifier](src/mcp/server/auth/provider.py) for more details on impleme
589589
The fastest way to test and debug your server is with the MCP Inspector:
590590

591591
```bash
592-
mcp dev server.py
592+
uv run mcp dev server.py
593593

594594
# Add dependencies
595-
mcp dev server.py --with pandas --with numpy
595+
uv run mcp dev server.py --with pandas --with numpy
596596

597597
# Mount local code
598-
mcp dev server.py --with-editable .
598+
uv run mcp dev server.py --with-editable .
599599
```
600600

601601
### Claude Desktop Integration
602602

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

605605
```bash
606-
mcp install server.py
606+
uv run mcp install server.py
607607

608608
# Custom name
609-
mcp install server.py --name "My Analytics Server"
609+
uv run mcp install server.py --name "My Analytics Server"
610610

611611
# Environment variables
612-
mcp install server.py -v API_KEY=abc123 -v DB_URL=postgres://...
613-
mcp install server.py -f .env
612+
uv run mcp install server.py -v API_KEY=abc123 -v DB_URL=postgres://...
613+
uv run mcp install server.py -f .env
614614
```
615615

616616
### Direct Execution
@@ -630,10 +630,10 @@ Run it with:
630630
```bash
631631
python server.py
632632
# or
633-
mcp run server.py
633+
uv run mcp run server.py
634634
```
635635

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

638638
### Streamable HTTP Transport
639639

@@ -949,7 +949,7 @@ if __name__ == "__main__":
949949
asyncio.run(run())
950950
```
951951

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

954954
#### Structured Output Support
955955

0 commit comments

Comments
 (0)