fix(genkit-tools/mcp): Add docs to top-level tool descriptions#4416
fix(genkit-tools/mcp): Add docs to top-level tool descriptions#4416
Conversation
Summary of ChangesHello @ssbushi, 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 significantly improves the discoverability and usability of Genkit tools by automatically augmenting their descriptions with details about their expected input parameters. This change streamlines the process for users to understand how to interact with each tool without needing to inspect the full schema separately, thereby enhancing the overall developer experience. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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
Customization To customize 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 Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. 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. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a consistent way to enrich tool descriptions with information from their input schemas. A new enrichToolDescription utility function has been added for this purpose, and it's used across various tool definitions (docs, flows, runtime, trace, usage). This refactoring improves code clarity and maintainability by centralizing the logic for generating tool descriptions. My review includes a suggestion to improve the formatting of the generated argument descriptions for better readability.
| const args = Object.entries(schema) | ||
| .map(([key, value]) => { | ||
| const desc = value.description; | ||
| return desc ? `${key}: ${desc}` : key; | ||
| }) | ||
| .join('; '); | ||
|
|
||
| if (args.length === 0) return baseDescription; | ||
|
|
||
| return `${baseDescription} Arguments: ${args}`; |
There was a problem hiding this comment.
The current implementation joins argument descriptions with a semicolon, which can be hard to read, especially with longer descriptions. Using a markdown list would improve readability for both developers and LLMs that might consume this description.
This change formats the arguments as a markdown list, which is clearer and more structured.
const entries = Object.entries(schema);
if (entries.length === 0) {
return baseDescription;
}
const argsList = entries
.map(([key, value]) => {
const desc = value.description;
return `\n- ${key}${desc ? `: ${desc}` : ''}`;
})
.join('');
return `${baseDescription}\n\nArguments:${argsList}`;
|
This change is no longer needed with the new MCP tools refactor. |
1 participant
Before:
After:
Checklist (if applicable):