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

Add documentation where uvx published programs run (working dir) #74

Open
MarkusPfundstein opened this issue Dec 5, 2024 · 1 comment

Comments

@MarkusPfundstein
Copy link

Title: Documentation needed: Clarify npx execution context and environment configuration

I'd like to request additional documentation regarding the execution context when running the server via npx. Specifically, the documentation should address the working directory context for npx execution.

This came up through a user question (see: MarkusPfundstein/mcp-obsidian#6) where they were unsure about the proper location for the .env file when running the published server. Currently, this information isn't clearly documented.

Having this information in the docs would help users properly configure and run the server without confusion.

Thanks for considering this addition to the documentation.

@dsp-ant dsp-ant transferred this issue from modelcontextprotocol/python-sdk Dec 10, 2024
@dsp-ant
Copy link
Member

dsp-ant commented Dec 10, 2024

I can see why such documentation is useful. I think the right way is for servers to accept a --config or --env-file parameter. This feels the most portable. While we could add a cwd parameter in claude desktop, other clients might not implement it. The working directory will be the working directory of the client/host application, e.g. Claude Desktop.

If we want to document the behaviour, I wonder if you would have some time to take a stab at it. A PR would be much appreciated.

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

2 participants