From 7f6b36cd06c5eb06674e10a4ca49207322ef5d81 Mon Sep 17 00:00:00 2001 From: Tadeo Donegana Date: Fri, 14 Mar 2025 11:33:02 -0300 Subject: [PATCH 1/2] Add clearer installation instructions --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c062f3a9b4..3413780b39 100644 --- a/README.md +++ b/README.md @@ -69,23 +69,38 @@ The Model Context Protocol allows applications to provide context for LLMs in a ### 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: +We recommend using [uv](https://docs.astral.sh/uv/) to manage your Python projects. To get started with a new project: ```bash -uv add "mcp[cli]" +# Create a new directory for your project +uv init my-mcp-project +cd my-mcp-project + +# Create virtual environment and activate it +uv venv +source .venv/bin/activate # On Windows use: .venv\Scripts\activate + +# Install MCP with CLI tools and the httpx package +uv add "mcp[cli]" httpx ``` -Alternatively, for projects using pip for dependencies: +For pip-based projects: ```bash pip install mcp +mcp --help ``` -### Running the standalone MCP development tools - -To run the mcp command with uv: +### Running an MCP server ```bash +# Running the standalone MCP development tools uv run mcp + +# See available commands +uv run mcp --help + +# Run a specific server +uv run mcp dev server.py ``` ## Quickstart From 4443cde31714e10c6e6bb29afa3c72a0dcabef9f Mon Sep 17 00:00:00 2001 From: Tadeo Donegana Date: Mon, 17 Mar 2025 17:46:29 -0300 Subject: [PATCH 2/2] fix: remove unneeded instructions --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3413780b39..c8549424e1 100644 --- a/README.md +++ b/README.md @@ -76,12 +76,8 @@ We recommend using [uv](https://docs.astral.sh/uv/) to manage your Python projec uv init my-mcp-project cd my-mcp-project -# Create virtual environment and activate it -uv venv -source .venv/bin/activate # On Windows use: .venv\Scripts\activate - -# Install MCP with CLI tools and the httpx package -uv add "mcp[cli]" httpx +# Install MCP with CLI tools +uv add "mcp[cli]" ``` For pip-based projects: