From 02062c5a5043bb48daa142da526a65fc13ce70dc Mon Sep 17 00:00:00 2001 From: Alex Clarke Date: Fri, 20 Feb 2026 15:00:32 -0700 Subject: [PATCH] docs: Created README docs for the CodeRabbit-style Code reviewer agents --- assets/agents/code-reviewer/README.md | 36 +++++++++++++++++++++++++++ assets/agents/file-reviewer/README.md | 35 ++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 assets/agents/code-reviewer/README.md create mode 100644 assets/agents/file-reviewer/README.md diff --git a/assets/agents/code-reviewer/README.md b/assets/agents/code-reviewer/README.md new file mode 100644 index 0000000..625b89a --- /dev/null +++ b/assets/agents/code-reviewer/README.md @@ -0,0 +1,36 @@ +# Code Reviewer + +A CodeRabbit-style code review orchestrator that coordinates per-file reviews and synthesizes findings into a unified +report. + +This agent acts as the manager for the review process, delegating actual file analysis to **[File Reviewer](../file-reviewer/README.md)** +agents while handling coordination and final reporting. + +## Features + +- 🤖 **Orchestration**: Spawns parallel reviewers for each changed file. +- 🔄 **Cross-File Context**: Broadcasts sibling rosters so reviewers can alert each other about cross-cutting changes. +- 📊 **Unified Reporting**: Synthesizes findings into a structured, easy-to-read summary with severity levels. +- ⚡ **Parallel Execution**: Runs reviews concurrently for maximum speed. + +## Pro-Tip: Use an IDE MCP Server for Improved Performance +Many modern IDEs now include MCP servers that let LLMs perform operations within the IDE itself and use IDE tools. Using +an IDE's MCP server dramatically improves the performance of coding agents. So if you have an IDE, try adding that MCP +server to your config (see the [MCP Server docs](../../../docs/function-calling/MCP-SERVERS.md) to see how to configure +them), and modify the agent definition to look like this: + +```yaml +# ... + +mcp_servers: + - jetbrains # The name of your configured IDE MCP server + +global_tools: + - fs_read.sh + - fs_grep.sh + - fs_glob.sh +# - execute_command.sh + +# ... +``` + diff --git a/assets/agents/file-reviewer/README.md b/assets/agents/file-reviewer/README.md new file mode 100644 index 0000000..d2528e8 --- /dev/null +++ b/assets/agents/file-reviewer/README.md @@ -0,0 +1,35 @@ +# File Reviewer + +A specialized worker agent that reviews a single file's diff for bugs, style issues, and cross-cutting concerns. + +This agent is designed to be spawned by the **[Code Reviewer](../code-reviewer/README.md)** agent. It focuses deeply on +one file while communicating with sibling agents to catch issues that span multiple files. + +## Features + +- 🔍 **Deep Analysis**: Focuses on bugs, logic errors, security issues, and style problems in a single file. +- 🗣️ **Teammate Communication**: Sends and receives alerts to/from sibling reviewers about interface or dependency + changes. +- 🎯 **Targeted Reading**: Reads only relevant context around changed lines to stay efficient. +- 🏷️ **Structured Findings**: Categorizes issues by severity (🔴 Critical, 🟡 Warning, 🟢 Suggestion, 💡 Nitpick). + +## Pro-Tip: Use an IDE MCP Server for Improved Performance +Many modern IDEs now include MCP servers that let LLMs perform operations within the IDE itself and use IDE tools. Using +an IDE's MCP server dramatically improves the performance of coding agents. So if you have an IDE, try adding that MCP +server to your config (see the [MCP Server docs](../../../docs/function-calling/MCP-SERVERS.md) to see how to configure +them), and modify the agent definition to look like this: + +```yaml +# ... + +mcp_servers: + - jetbrains # The name of your configured IDE MCP server + +global_tools: + - fs_read.sh + - fs_grep.sh + - fs_glob.sh + +# ... +``` +