-
Notifications
You must be signed in to change notification settings - Fork 17
fix(chat): document Google Chat Markdown formatting in tool descriptions #109
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
base: main
Are you sure you want to change the base?
fix(chat): document Google Chat Markdown formatting in tool descriptions #109
Conversation
Update `chat.sendMessage` and `chat.sendDm` tool descriptions to document Google Chat's supported text formatting syntax, helping LLMs generate properly formatted messages. Changes: - Add `CHAT_FORMATTING` and `CHAT_FORMATTING_SHORT` constants in `src/utils/formatting/constants.ts` - Update `chat.sendMessage` tool description to include full formatting instructions - Update `chat.sendMessage` parameter description to include short formatting instructions - Update `chat.sendDm` tool description to include full formatting instructions - Update `chat.sendDm` parameter description to include short formatting instructions Based on PR gemini-cli-extensions#103.
Summary of ChangesHello @kamladi, 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 enhances the Highlights
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
|
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 effectively documents the Google Chat specific formatting for the chat.sendMessage and chat.sendDm tools by introducing shared constants. My review includes suggestions to make the formatting documentation even more complete by including all unsupported syntax mentioned in the PR description. I've also recommended a minor stylistic improvement to use template literals for better code readability.
… unsupported markdown features in the formatting instructions
allenhutchison
left a comment
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.
One question and one comment for you.
| "chat.sendMessage", | ||
| { | ||
| description: 'Sends a message to a Google Chat space.', | ||
| description: `Sends a message to a Google Chat space. ${CHAT_FORMATTING}`, |
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.
Did you try adding these to the GEMINI-workspace.md file? It seems like a little overkill to add these to every tool description, but if you tried that and it didn't work I would understand why you took this route.
| @@ -0,0 +1,28 @@ | |||
| export const CHAT_FORMATTING_SHORT = [ | |||
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.
We need a license header here to clear lint. If you run npm run lint:fix it should do the right thing.
Update
chat.sendMessageandchat.sendDmtool descriptions to document Google Chat's supported text formatting syntax, helping LLMs generate properly formatted messages.Partially addresses #58 (Chat formatting task).
Changes:
Testing:
**bold**and__bold__to*bold**italic*to_italic_[text](url)to<url|text>Supported syntax:
Unsupported syntax (must be converted or avoided):