Skip to content

docs: fix dev server command in README (#848) #859

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Lasdw6
Copy link

@Lasdw6 Lasdw6 commented May 30, 2025

This PR updates the README to correct the development server startup command from:

mcp dev server.py

to:

uv run mcp dev server.py

Motivation and Context

Per issue #848, the existing command in the README does not work and prevents users from launching the MCP development server. This change ensures the documented command is accurate and functional.

How Has This Been Tested?

N/A

Breaking Changes

N/A

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
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

N/A

@Kludex
Copy link
Member

Kludex commented Jun 2, 2025

There are many other commands in this page that don't use uv.

@Lasdw6
Copy link
Author

Lasdw6 commented Jun 2, 2025

Thanks for pointing that out! I’ve now prefixed all $ mcp … examples with uv run, not just the dev server. You can see the updated lines in the latest commit, every MCP CLI snippet should now start with uv run mcp ….. Let me know if I missed any.

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