Skip to content

docs: Update installation instructions for clarity #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

docs: Update installation instructions for clarity #288

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7f6b36c
Add clearer installation instructions
tadeodonegana Mar 14, 2025
d9e27a8
Merge branch 'main' into feat/enhance-installation-instructions
tadeodonegana Mar 14, 2025
4443cde
fix: remove unneeded instructions
tadeodonegana Mar 17, 2025
cc857bd
Merge branch 'feat/enhance-installation-instructions' of https://gith…
tadeodonegana Mar 17, 2025
797f6ea
Merge branch 'main' into feat/enhance-installation-instructions
tadeodonegana Mar 17, 2025
27e0aa0
Merge branch 'main' into feat/enhance-installation-instructions
tadeodonegana Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Create virtual environment and activate it
uv venv
source .venv/bin/activate # On Windows use: .venv\Scripts\activate

There's no need to explicitly create and activate the virtual environment, uv takes care of that implicitly. See https://docs.astral.sh/uv/concepts/projects/layout/#the-project-environment

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your comment, @taha-yassine. I added it because the official MCP docs explicitly mention the virtual environment. It might be a good idea to review those docs as well.

I have removed the explicit creation of the virtual environment in this PR in order to proceed. Thanks!


# Install MCP with CLI tools and the httpx package
uv add "mcp[cli]" httpx
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would you need httpx? It's a dependency of mcp already.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your comment, @Kludex.

I originally added it because the official MCP docs explicitly mention it—likely due to the example provided in the documentation.

Since, as you mentioned, the dependency isn’t needed to run the python-sdk, I’ve removed it from this PR. Gracias!

```

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
Expand Down