From fe20e2e7fbb3c85839348a6a2259131f5ced369a Mon Sep 17 00:00:00 2001 From: John L Chen Date: Thu, 13 Mar 2025 21:38:02 +0800 Subject: [PATCH] Update README to clarify installing mcp to project vs running mcp 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. --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bdbc9bca..41d3cc62 100644 --- a/README.md +++ b/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: