-
Notifications
You must be signed in to change notification settings - Fork 750
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.
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
docs: Update installation instructions for clarity #288
base: main
Are you sure you want to change the base?
docs: Update installation instructions for clarity #288
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is far more clear, thank you! Note: I do not have access to approve.
Rendered View: https://github.com/modelcontextprotocol/python-sdk/blob/d9e27a89/README.md#installation
README.md
Outdated
# Create virtual environment and activate it | ||
uv venv | ||
source .venv/bin/activate # On Windows use: .venv\Scripts\activate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# 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
There was a problem hiding this comment.
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!
README.md
Outdated
source .venv/bin/activate # On Windows use: .venv\Scripts\activate | ||
|
||
# Install MCP with CLI tools and the httpx package | ||
uv add "mcp[cli]" httpx |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I appreciate the effort. I don't think we need additional instructions to create a project. If we want to go down the path, we should skip the explicit creation of the .venv, since uv run
will manage this for us, and I don't want to confuse people with additional instructions about venv management.
I have applied the requested changes. @dsp-ant, I would appreciate another review of these changes to see if we can move forward. Thanks! |
Update installation instructions in README to acknowledge issues #269 and #111
Used the official docs to enhance the existing example and make it more straightforward.
Demonstration of the updated installation flow:
installation-flow.mp4
Motivation and Context
Issues #269 and #111.
How Has This Been Tested?
Breaking Changes
Types of changes
Checklist
Additional context