feat: Standardize README structure

[Royal-lobster]

Summary

• Standardizes README.md to follow the IQ.AI MCP README format
• Adds auto-generation workflow for tool documentation
• Adds npm and license badges to header
• Adds all required sections: Overview, Features, Installation, Running with MCP Client, Configuration, Usage Examples, MCP Tools, Development, Resources, Disclaimer, License
• Adds AUTO-GENERATED TOOLS markers for tool documentation

Test plan

• README structure validated against standardized format
• All required sections present
• Auto-generation markers in place
• Package.json updated with zod-to-json-schema dependency

🤖 Generated with Claude Code

[gemini-code-assist]

Summary of Changes

Hello @Royal-lobster, I'm Gemini Code Assist¹! 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 README.md structure according to the IQ.AI MCP format. It introduces an automated process to generate and embed detailed documentation for the project's Model Context Protocol (MCP) tools directly into the README, ensuring that tool parameters and descriptions are always up-to-date. This change improves clarity for users and streamlines the documentation workflow for developers.

Highlights

• README Standardization: The README.md has been standardized to align with the IQ.AI MCP README format, ensuring consistent and comprehensive project documentation.
• Automated Tool Documentation: An automated workflow has been introduced to generate and embed detailed documentation for MCP tools directly into the README.md, ensuring tool parameters and descriptions are always up-to-date.
• Badges and Structure: Npm and license badges have been added to the README.md header, and all required sections (Overview, Features, Installation, Configuration, Usage Examples, Development, etc.) are now present.
• Dependency Addition: The zod-to-json-schema dependency was added to facilitate the conversion of Zod schemas into JSON Schema for automated tool parameter documentation.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/sync-tools.yml

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. 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

1. 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. ↩

[Royal-lobster]

Closing PR as main branch already has the standardized README structure.

[gemini-code-assist]

Code Review

This pull request significantly improves the project's documentation by standardizing the README.md file and introducing a script to auto-generate documentation for MCP tools. The new README is well-structured, informative, and easy to follow. The auto-generation script is a great step towards better maintainability. I have one minor suggestion for the script to enhance its cross-platform compatibility. Overall, excellent work on improving the project's developer experience.

[gemini-code-assist]

For better cross-platform compatibility, especially on Windows, it's safer to convert file paths to file:// URLs before using them in dynamic import() statements. path.join() creates platform-specific paths (e.g., with \ on Windows), which might not be correctly resolved by import().

You can achieve this by importing pathToFileURL here and then using it on line 30 as follows:

const mod = await import(pathToFileURL(path.join(TOOLS_DIR, file)).href);

Suggested change

	import { fileURLToPath } from "node:url";
	import { fileURLToPath, pathToFileURL } from "node:url";