-
Notifications
You must be signed in to change notification settings - Fork 1k
[MCP] Update descriptions of the consult_assistant tool #8915
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @fredzqm, 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 focuses on improving the clarity and utility of the consult_assistant
tool's documentation. By providing more comprehensive descriptions for both the tool itself and its primary input parameter, it aims to give users a much better understanding of the tool's capabilities and how to interact with it effectively, especially for Firebase-related inquiries.
Highlights
- Enhanced Tool Description: The
consult_assistant
tool's description has been significantly expanded to clearly articulate its specialization in Firebase, detailing the types of information it can provide (e.g., detailed information, best practices, troubleshooting, code examples, contextual help) and the specific Firebase services it covers (Firestore, Authentication, Cloud Functions, Hosting, Storage, Analytics). - Improved Prompt Guidance: The description for the
prompt
input parameter of theconsult_assistant
tool has been updated to offer more precise instructions and illustrative examples, guiding users on how to formulate effective and detailed queries for the Firebase assistant.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
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 issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
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 .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 counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this 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 descriptions for the consult_assistant
tool, making them more detailed and helpful. The changes are a definite improvement. I've provided a couple of suggestions to enhance the maintainability of the long description strings by using Array.prototype.join()
instead of string concatenation, which also helps resolve a minor formatting inconsistency in one of the strings.
"Access an AI assistant specialized in all aspects of **Firebase**. " + | ||
"Use this tool to get **detailed information**, **best practices**, **troubleshooting steps**, **code examples**, and **contextual help** regarding Firebase services, features, and project configuration. " + | ||
"This includes questions about Firestore, Authentication, Cloud Functions, Hosting, Storage, Analytics, and more. " + | ||
"It can also provide insights based on the **current Firebase project context**.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For improved readability and maintainability, consider using an array of strings joined together instead of direct string concatenation. This approach is often cleaner, less error-prone (e.g., forgetting a trailing space), and makes it easier to manage individual parts of the description.
[
"Access an AI assistant specialized in all aspects of **Firebase**.",
"Use this tool to get **detailed information**, **best practices**, **troubleshooting steps**, **code examples**, and **contextual help** regarding Firebase services, features, and project configuration.",
"This includes questions about Firestore, Authentication, Cloud Functions, Hosting, Storage, Analytics, and more.",
"It can also provide insights based on the **current Firebase project context**.",
].join(" "),
.describe( | ||
"The specific question or task related to Firebase. " + | ||
"Be precise and include relevant details, such as the Firebase service in question, the desired outcome, or any error messages encountered. " + | ||
"Examples: 'What's the best way to deploy a React app to Firebase Hosting?', 'Explain Firebase Authentication with Google Sign-In.' , 'What are the current project settings for 'projectId'? ", | ||
), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to the description
field, using Array.prototype.join()
here can improve readability.
Additionally, this change corrects a minor formatting inconsistency in the list of examples:
- Removes the extra space after
Examples:
. - Fixes the inconsistent spacing around the comma separating the examples (
'Sign-In.' , 'What...
).
.describe(
[
"The specific question or task related to Firebase.",
"Be precise and include relevant details, such as the Firebase service in question, the desired outcome, or any error messages encountered.",
"Examples: 'What's the best way to deploy a React app to Firebase Hosting?', 'Explain Firebase Authentication with Google Sign-In.', 'What are the current project settings for \'projectId\'?'",
].join(" ")
),
Make the PR per Thevi's request. |
No description provided.