docs: add environment variables guide#2296
Open
ameenalkhaldi wants to merge 1 commit intomodelcontextprotocol:mainfrom
Open
docs: add environment variables guide#2296ameenalkhaldi wants to merge 1 commit intomodelcontextprotocol:mainfrom
ameenalkhaldi wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
Document common patterns for passing and accessing environment variables in MCP servers, covering tool functions, Claude Desktop configuration, CLI usage, programmatic clients, and built-in MCPServer settings. Github-Issue:modelcontextprotocol#1277 Reported-by:ilvalerione
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #1277.
Adds a documentation page covering the common patterns for working with environment variables in MCP servers. This was a frequently asked question with no dedicated documentation.
The guide covers:
os.environ/os.getenv())mcp installCLI, direct execution, and programmaticStdioServerParametersMCP_-prefixed settings recognized byMCPServerChanges
docs/environment-variables.md: New documentation page with practical examplesmkdocs.yml: Added the page to the Documentation nav sectionTest plan