Add 'getting started' extensions documentation#9536
Conversation
Summary of ChangesHello @chrstnb, 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 introduces essential documentation to guide users through the process of developing Gemini CLI extensions, making it easier to get started with custom functionalities. Concurrently, it addresses and rectifies issues within the existing 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.
Code Review
This pull request introduces a 'getting started' guide for creating Gemini CLI extensions and updates the mcp-server example to be a complete, buildable TypeScript project. The changes are a great improvement, especially the new documentation. I've found a couple of issues: a critical bug in one of the code examples in the new documentation that would prevent it from running, and a confusing hardcoded name in the updated mcp-server example that creates an inconsistency with the documentation. My review includes suggestions to fix these points.
| 'fetch_posts', | ||
| { | ||
| description: 'Fetches a list of posts from a public API.', | ||
| inputSchema: z.object({}).shape, |
There was a problem hiding this comment.
The inputSchema for the fetch_posts tool is defined as z.object({}).shape. The .shape property of a Zod object schema returns the raw shape definition (in this case, an empty object {}), not the Zod schema instance itself. The registerTool function expects a Zod schema. This will cause a runtime error for users following this guide. The schema should be passed directly.
| inputSchema: z.object({}).shape, | |
| inputSchema: z.object({}), |
|
Size Change: +211 B (0%) Total Size: 17.4 MB ℹ️ View Unchanged
|
…i-extension.json Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
TLDR
Also updated the MCP server example because it was kind of borked. I'd like to add readmes to each of those directories... that can come later :)
Dive Deeper
Reviewer Test Plan
Testing Matrix
Linked issues / bugs