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

README is full of errors. #269

Open
emsi opened this issue Mar 12, 2025 · 2 comments
Open

README is full of errors. #269

emsi opened this issue Mar 12, 2025 · 2 comments

Comments

@emsi
Copy link
Contributor

emsi commented Mar 12, 2025

README says to run:
uv add "mcp[cli]"

If anyone will follow this advice she'll get the error:

error: Requirement name mcp matches project name mcp, but self-dependencies are not permitted without the --dev or --optional flags. If your project name (mcp) is shadowing that of a third-party dependency, consider renaming the project.

The instruction is completely wrong.
One needs to first create its own project. Initialize it with uv init and only then can use the uv add command. But even then the subsequent calls of mcp won't work because uv add does not install mcp[cli] as a command. The best way to run mcp cli via uv is uv run mcp.

In general the README.md in current state can be a source of confusion.
Someone has already reported this #111 but it was not addressed.

@emsi emsi changed the title README is full opf errors. README is full of errors. Mar 12, 2025
@dsp-ant
Copy link
Member

dsp-ant commented Mar 13, 2025

Do you mind taking a stab at improving the README?

@tadeodonegana
Copy link

tadeodonegana commented Mar 14, 2025

I have just opened a PR addressing issue #288.

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

No branches or pull requests

3 participants