Conversation
- Reorganize README to follow standard MCP documentation format - Add npm version and license badges - Add structured sections: Overview, Features, Installation, Configuration - Add usage examples with natural language prompts - Add auto-generated MCP Tools section with parameter tables - Add sync-tools workflow for automatic tool documentation updates - Add zod-to-json-schema dependency for schema conversion Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Summary of ChangesHello @Royal-lobster, 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 enhances the project's documentation and maintainability by standardizing the Highlights
Ignored Files
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 standardized README structure and an automated workflow for generating documentation for MCP tools. These are excellent improvements for the project's documentation and maintainability. The new README is much clearer and more user-friendly. The script for auto-generating tool documentation from Zod schemas is a great addition. I've provided a couple of suggestions on the new generation script to enhance code style and improve the accuracy of the generated documentation.
| const defaultVal = | ||
| prop.default !== undefined ? JSON.stringify(prop.default) : ""; |
There was a problem hiding this comment.
The deadline parameter in GET_NEAR_SWAP_FULL_QUOTE has a dynamic default value (1 hour from now). However, zod-to-json-schema evaluates this at generation time, resulting in a static, soon-to-be-outdated timestamp in the README. This can be misleading for users, as the Default column will not reflect the dynamic nature described in the Description column. To avoid this confusion, you could consider omitting the default value for deadline from the generated table or replacing it with a descriptive placeholder like now + 1 hour.
| function renderMarkdown(tools) { | ||
| let md = ""; | ||
|
|
||
| for (const tool of tools) { | ||
| const schema = tool.parameters || tool.schema; | ||
|
|
||
| md += `### \`${tool.name}\`\n`; | ||
| md += `${tool.description}\n\n`; | ||
| md += `${renderSchema(schema)}\n\n`; | ||
| } | ||
|
|
||
| return md.trim(); | ||
| } |
There was a problem hiding this comment.
The renderMarkdown function can be written more concisely and efficiently using array methods like map and join. This avoids string concatenation in a loop, which is generally more performant and idiomatic in modern JavaScript.
function renderMarkdown(tools) {
return tools
.map((tool) => {
const schema = tool.parameters || tool.schema;
return `### \`${tool.name}\`\n${tool.description}\n\n${renderSchema(schema)}`;
})
.join("\n\n");
}1 participant
Summary
Changes
Test plan
pnpm run build)pnpm run lint)Generated with Claude Code