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

Update README to clarify installing mcp to project vs running mcp #277

Merged
merged 1 commit into from
Mar 13, 2025

Conversation

john0312
Copy link
Contributor

This change updates the README to avoid folks misunderstanding the uv add command.

Motivation and Context

This is in response to issue #269

How Has This Been Tested?

I've tested the commands in this change (uv add and uv run) and it's in line with what the new wording suggests.

Breaking Changes

None.

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)
  • Documentation update

Checklist

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

Additional context

None, this is just a README update.

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.
@dsp-ant
Copy link
Member

dsp-ant commented Mar 13, 2025

Thank you

@dsp-ant dsp-ant enabled auto-merge (squash) March 13, 2025 14:35
@dsp-ant dsp-ant merged commit ebb81d3 into modelcontextprotocol:main Mar 13, 2025
3 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