feat: standardize README structure and add auto-sync workflow#5
feat: standardize README structure and add auto-sync workflow#5Royal-lobster merged 1 commit intomainfrom
Conversation
- Update README to match standardized structure (badges, overview, features, installation, configuration, tools, development, resources) - Add auto-generated MCP tools documentation section - Add sync-tools.yml workflow to automatically update README when tools change - Add generate-mcp-tools action to generate tool documentation from source - Add zod-to-json-schema dev dependency for tool 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 restructuring 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 successfully standardizes the README structure and introduces an automated workflow to keep the MCP tools documentation up-to-date. The new generate-mcp-tools action is a great addition for maintaining consistency and reducing manual effort. The README itself is much clearer and well-organized now.
| const files = fs | ||
| .readdirSync(TOOLS_DIR) | ||
| .filter((f) => f.endsWith(".ts") && f !== "index.ts"); |
There was a problem hiding this comment.
Using synchronous file system operations like fs.readdirSync can block the Node.js event loop. While this script runs in a dedicated environment (GitHub Action), it's generally a best practice to use asynchronous versions (fs.promises.readdir) to prevent potential blocking issues, especially if the script's scope were to expand or be integrated into a larger application. This also aligns with modern Node.js practices.
const files = (await fs.promises.readdir(TOOLS_DIR))
.filter((f) => f.endsWith(".ts") && f !== "index.ts");|
|
||
| async function main() { | ||
| try { | ||
| const readme = fs.readFileSync(README_PATH, "utf8"); |
There was a problem hiding this comment.
Similar to the previous comment, fs.readFileSync is a synchronous operation. It's recommended to use fs.promises.readFile for asynchronous file reading to maintain non-blocking behavior.
const readme = await fs.promises.readFile(README_PATH, "utf8");| } | ||
|
|
||
| const updated = updateReadme({ readme, tools }); | ||
|
|
There was a problem hiding this comment.
Using fs.writeFileSync is a synchronous operation. For better practice and non-blocking I/O, consider using fs.promises.writeFile.
await fs.promises.writeFile(README_PATH, updated);1 participant
Summary
sync-tools.ymlworkflow to automatically update README when tools change on main branchgenerate-mcp-toolsaction that extracts tool documentation from source codezod-to-json-schemadev dependency for converting Zod schemas to JSON SchemaTest plan
pnpm run build- passespnpm run lint- passesGenerated with Claude Code