Skip to content

docs: explain MCP env expansion#28248

Open
JSap0914 wants to merge 1 commit into
google-gemini:mainfrom
JSap0914:docs/mcp-env-expansion-28228
Open

docs: explain MCP env expansion#28248
JSap0914 wants to merge 1 commit into
google-gemini:mainfrom
JSap0914:docs/mcp-env-expansion-28228

Conversation

@JSap0914

@JSap0914 JSap0914 commented Jul 3, 2026

Copy link
Copy Markdown

Summary

  • add a dedicated mcpServers path/environment expansion subsection
  • document supported $VAR, ${VAR}, ${VAR:-fallback}, and Windows %VAR% syntax
  • call out unsupported {{VAR}}, ${env:VAR}, and ~, plus missing variables expanding to an empty string
  • mirror the warning in the MCP setup tutorial

Fixes #28228.

Verification

  • npx prettier --check docs/reference/configuration.md docs/cli/tutorials/mcp-setup.md

@JSap0914 JSap0914 requested review from a team as code owners July 3, 2026 12:02
@google-cla

google-cla Bot commented Jul 3, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request improves the documentation for the Gemini CLI by clarifying how environment variables are expanded within mcpServers configurations. It provides users with clear guidelines on supported syntax, platform-specific behaviors, and common pitfalls, ensuring a more predictable configuration experience.

Highlights

  • Documentation Update: Added a dedicated section explaining environment variable expansion for mcpServers configuration.
  • Syntax Clarification: Documented supported formats including $VAR, ${VAR}, ${VAR:-fallback}, and %VAR% for Windows, while noting unsupported patterns like {{VAR}} and ~.
  • Best Practices: Provided clear examples for cross-platform path configuration and warned about the behavior of missing variables.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions github-actions Bot added the size/s A small PR label Jul 3, 2026
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown

📊 PR Size: size/S

  • Lines changed: 35
  • Additions: +35
  • Deletions: -0
  • Files changed: 2

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation to detail environment variable expansion support within mcpServers configuration settings, including syntax rules and usage examples. There are no review comments, and I have no feedback to provide.

Note: Security Review has been skipped due to the limited scope of the PR.

@gemini-cli

gemini-cli Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Hi there! Thank you for your interest in contributing to Gemini CLI.

To ensure we maintain high code quality and focus on our prioritized roadmap, we only guarantee review and consideration of pull requests for issues that are explicitly labeled as 'help wanted'.

This PR will be closed in 7 days if it remains without that designation. We encourage you to find and contribute to existing 'help wanted' issues in our backlog! Thank you for your understanding.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs+DX: mcpServers env-var expansion syntax is undocumented; silent-fail on unexpanded/missing paths

1 participant