Skip to content
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 : Enhance README to suggest commands for creating a new UV project before adding mcp dependency. #408

Merged
merged 1 commit into from
Apr 2, 2025

Conversation

anupsajjan
Copy link
Contributor

Enhanced README to include suggestion for creating a uv project before adding mcp dependency.

Motivation and Context

Personally whenever I read docs, I go on executing series of commands to do initial setup. But here I found hyperlink to UV which had docs to install UV, but didnt had any mention about creation of project. Hence running uv add "mcp[cli]" was ending up with error.

Only once I did $uv --help to understand how to create a new project and then uv add "mcp[cli]" started working.
Might seem simple, but for many people with new tech stacks, will end up spending some time to realize this.
Hence adding it directly in the docs to help quickly setup MCP python sdk.

How Has This Been Tested?

I have done a preview of README and verified changes
image

Breaking Changes

NA

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • [x ] Documentation update

Checklist

  • [ x] I have read the MCP Documentation
  • [x ] My code follows the repository's style guidelines
  • [x ] New and existing tests pass locally
  • [x ] I have added appropriate error handling
  • [x ] I have added or updated documentation as needed

Additional context

NA

Copy link
Member

@dsp-ant dsp-ant left a comment

Choose a reason for hiding this comment

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

Actually, I quite like that! Thank you

@dsp-ant dsp-ant merged commit c2ca8e0 into modelcontextprotocol:main Apr 2, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants