Skip to content

docs: update subagent configuration schema table#26983

Open
mwilliams31 wants to merge 2 commits into
google-gemini:mainfrom
mwilliams31:main
Open

docs: update subagent configuration schema table#26983
mwilliams31 wants to merge 2 commits into
google-gemini:mainfrom
mwilliams31:main

Conversation

@mwilliams31
Copy link
Copy Markdown

@mwilliams31 mwilliams31 commented May 13, 2026

Summary

Adds the display_name field to the subagent configuration schema and corrects the mcp_servers field name.

Details

Incorporated based on localAgentSchema definition in agentLoader.ts.

Related Issues

Fixes #26984.

How to Validate

  1. Review the updated documentation for the subagent configuration.
  2. Ensure both the display_name and mcp_servers fields are included and correctly formatted in the configuration.
  3. Test the UI to confirm the display name appears as expected and that MCP servers function as intended.

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run
      • npx
      • Docker
      • Podman
      • Seatbelt
    • Windows
      • npm run
      • npx
      • Docker
    • Linux
      • npm run
      • npx
      • Docker

@mwilliams31 mwilliams31 requested review from a team as code owners May 13, 2026 14:09
@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 updates the subagent configuration documentation to better align with the codebase. It introduces a new display_name field for improved UI presentation and corrects the naming convention of the mcp_servers field to match the actual implementation.

Highlights

  • Schema Update: Added the display_name field to the subagent configuration schema to support human-readable naming in user interfaces.
  • Field Correction: Renamed the mcpServers field to mcp_servers in the documentation to ensure consistency with the implementation.
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.

@mwilliams31 mwilliams31 changed the title Update subagent configuration schema table docs: update subagent configuration schema table May 13, 2026
Copy link
Copy Markdown
Contributor

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

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 subagent documentation by adding a display_name field and renaming mcpServers to mcp_servers. A review comment identifies that the rename is incomplete, as other references in the document still use the camelCase format, and recommends updating all instances for consistency.

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

Comment thread docs/core/subagents.md
@gemini-cli gemini-cli Bot added status/need-issue Pull requests that need to have an associated issue. area/documentation Gemini CLI documentation tasks and issues and removed status/need-issue Pull requests that need to have an associated issue. labels May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Gemini CLI documentation tasks and issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: subagent configuration schema

1 participant