fix: correct npm badge to point to @iqai/mcp-near package - #34
Conversation
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 primarily focuses on a significant refactoring of the project's naming conventions, standardizing the package name and its associated executable. The changes ensure that all project references, from installation commands to documentation, consistently reflect the new "@iqai/mcp-near" identifier. Additionally, a new automation script has been introduced to dynamically generate tool documentation, improving maintainability and accuracy. 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
|
- Changed package name from @iqai/mcp-near-agent to @iqai/mcp-near - Updated bin name to match package name - Fixed npm badge URL in README to point to correct package - Updated all npx commands, git clone URLs, and configuration examples - Updated repository, homepage, and bugs URLs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
ffdb3a8 to
c84f6ea
Compare
There was a problem hiding this comment.
Code Review
This pull request primarily focuses on renaming the package from @iqai/mcp-near-agent to @iqai/mcp-near and comprehensively updating the README.md to reflect this change and improve the overall documentation. A new GitHub Action script has been added to automatically generate documentation for MCP tools. The changes in package.json and README.md are correct and well-executed. My review includes a couple of suggestions for the new tool generation script to align it with Node.js best practices by using asynchronous I/O operations.
I am having trouble creating individual review comments. Click here to see my feedback.
.github/actions/generate-mcp-tools/generate-tools.mjs (25-27)
To align with Node.js best practices for non-blocking I/O, consider using the asynchronous fs.promises.readdir() instead of fs.readdirSync(). Since the loadTools function is already async, this change is straightforward and improves consistency.
const files = (await fs.promises.readdir(TOOLS_DIR)).filter(
(f) => f.endsWith(".ts") && f !== "index.ts",
);
.github/actions/generate-mcp-tools/generate-tools.mjs (136-146)
The main function is async, but it uses synchronous file system operations (readFileSync, writeFileSync). To follow Node.js best practices and avoid blocking the event loop, you should use their asynchronous counterparts (fs.promises.readFile, fs.promises.writeFile).
const readme = await fs.promises.readFile(README_PATH, "utf8");
const tools = await loadTools();
if (tools.length === 0) {
console.warn("Warning: No tools found!");
}
const updated = updateReadme({ readme, tools });
await fs.promises.writeFile(README_PATH, updated);
console.log(`Synced ${tools.length} MCP tools to README.md`);
Summary
@iqai/mcp-near-agentto@iqai/mcp-nearTest plan
🤖 Generated with Claude Code