docs: update README with non-interactive mode, new MCP tools, and agent tool list#404
docs: update README with non-interactive mode, new MCP tools, and agent tool list#404
Conversation
Summary of ChangesHello, 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 updates the project's README.md to reflect recent feature additions, including a new non-interactive CLI mode and several new tools for the MCP and agent functionalities. The changes aim to provide comprehensive and up-to-date documentation for users interacting with the codebase RAG system. Highlights
Changelog
Activity
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
The pull request updates the README to document new features. The documentation for the new agent tools seems correct based on the provided code. However, there are a couple of inconsistencies with the code in this branch for other documented features. Specifically, the --ask-agent CLI flag and the new MCP tools are documented but do not appear to be implemented in the provided code context. This could be because the features are in other PRs, but it makes the documentation incorrect for the current state of this branch. I've left specific comments on these sections.
| **Non-interactive mode (single query):** | ||
|
|
||
| Run a single query and exit, with output sent to stdout (useful for scripting): | ||
|
|
||
| ```bash | ||
| python -m codebase_rag.main start --repo-path /path/to/your/repo \ | ||
| --ask-agent "What functions call UserService.create_user?" | ||
| ``` |
There was a problem hiding this comment.
The documentation introduces the --ask-agent flag for non-interactive mode. However, based on the provided codebase_rag/main.py file, the start command does not have this option defined. This makes the documentation inconsistent with the current state of the code in this branch. Please ensure the feature is included in this PR or that this documentation is merged only after the corresponding feature PR.
| - **shell_command** - Execute terminal commands | ||
| - **document_analyzer** - Analyze PDFs and documents | ||
| - **semantic_search** - Find functions by intent | ||
| - **get_function_source** - Retrieve function source by ID |
There was a problem hiding this comment.
This change adds several new tools to the MCP server's available tools list. However, in the provided codebase_rag/mcp/tools.py file, these tools (shell_command, document_analyzer, semantic_search, get_function_source) are not registered in the MCPToolsRegistry. This makes the documentation inconsistent with the code in this branch.
Additionally, there seems to be a naming inconsistency. The agent tools for similar functionalities are named execute_shell_command, analyze_document, semantic_search_functions, and get_function_source_by_id. It would be good to ensure the MCP tool names are consistent or that the difference is intentional and clear.
Please ensure the tool registration is part of this PR or that this documentation is merged after the feature is implemented and the names are confirmed.
Greptile SummaryThis PR updates the README with documentation for three new features:
The documentation is clear, well-structured, and accurate. Agent tool names were verified against the actual implementation in Confidence Score: 5/5
Important Files Changed
Last reviewed commit: b269054 |
Document the new --ask-agent non-interactive CLI flag, add the four newly exposed MCP tools (shell_command, document_analyzer, semantic_search, get_function_source) to the tools list, and expand the agent tools section with analyze_document, semantic_search_functions, and get_function_source_by_id.
Dependency graph
Merge in this order: