Update README to clarify installing mcp to project vs running mcp (#277)
uv add is for adding dependency to uv managed python projects, and folks not familiar with uv may mistaken the command for running mcp. Added wordings that clarifies this.
This commit is contained in:
parent
9d0f2daddb
commit
ebb81d3b2b
1 changed files with 12 additions and 2 deletions
14
README.md
14
README.md
|
|
@ -67,17 +67,27 @@ The Model Context Protocol allows applications to provide context for LLMs in a
|
|||
|
||||
## Installation
|
||||
|
||||
We recommend using [uv](https://docs.astral.sh/uv/) to manage your Python projects:
|
||||
### Adding MCP to your python project
|
||||
|
||||
We recommend using [uv](https://docs.astral.sh/uv/) to manage your Python projects. In a uv managed python project, add mcp to dependencies by:
|
||||
|
||||
```bash
|
||||
uv add "mcp[cli]"
|
||||
```
|
||||
|
||||
Alternatively:
|
||||
Alternatively, for projects using pip for dependencies:
|
||||
```bash
|
||||
pip install mcp
|
||||
```
|
||||
|
||||
### Running the standalone MCP development tools
|
||||
|
||||
To run the mcp command with uv:
|
||||
|
||||
```bash
|
||||
uv run mcp
|
||||
```
|
||||
|
||||
## Quickstart
|
||||
|
||||
Let's create a simple MCP server that exposes a calculator tool and some data:
|
||||
|
|
|
|||
Loading…
Reference in a new issue