Skip to content

feat(mcp): add humanReadableDescription to MCP tools - #11016

Merged
joehan merged 2 commits into
mainfrom
feat/mcp-human-readable-descriptions
Sep 1, 2026
Merged

feat(mcp): add humanReadableDescription to MCP tools#11016
joehan merged 2 commits into
mainfrom
feat/mcp-human-readable-descriptions

Conversation

@joehan

@joehan joehan commented Sep 1, 2026

Copy link
Copy Markdown
Member

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

firebase mcp --generate-tool-list

### 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
```

@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 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.

Comment thread src/mcp/README.md
Comment thread src/mcp/tools/index.ts
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@joehan
joehan requested a review from chkuang-g September 1, 2026 17:54
@joehan
joehan merged commit 77998d6 into main Sep 1, 2026
51 checks passed
@joehan
joehan deleted the feat/mcp-human-readable-descriptions branch September 1, 2026 18:44
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

Successfully merging this pull request may close these issues.

3 participants