feat(mcp): add humanReadableDescription to MCP tools - #11016
Merged
Conversation
### Description Add `humanReadableDescription` to all MCP tools to provide concise 1-sentence summaries for human consumption, and use this field in `--generate-tool-list` output and documentation tables rather than the longer AI-oriented `description`. ### Scenarios Tested - Unit tests verify `humanReadableDescription` is attached to `ServerTool['mcp']`. - Unit tests verify `markdownDocsOfTools()` formats the table with `humanReadableDescription` and falls back to `description` when not present. - Ran fast test suite (`npm run mocha:fast`) and lint check (`npm run lint:changed-files`). ### Sample Commands ```bash firebase mcp --generate-tool-list ```
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a new humanReadableDescription field to MCP tools, allowing for shorter, human-friendly descriptions in user-facing documentation like the README. It updates various tool definitions, updates the documentation generation logic to prioritize this new field, and adds corresponding unit tests. The feedback highlights that several Firestore tools were missed and should also be updated with humanReadableDescription. Additionally, it is recommended to remove redundant optional chaining on tool.mcp in the documentation generator for better consistency.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
chkuang-g
approved these changes
Sep 1, 2026
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.
Description
Add
humanReadableDescriptionto all MCP tools to provide concise 1-sentence summaries for human consumption, and use this field in--generate-tool-listoutput and documentation tables rather than the longer AI-orienteddescription.Scenarios Tested
humanReadableDescriptionis attached toServerTool['mcp'].markdownDocsOfTools()formats the table withhumanReadableDescriptionand falls back todescriptionwhen not present.npm run mocha:fast) and lint check (npm run lint:changed-files).Sample Commands