docs: Add Roo Code custom mode integration guide#70
Merged
Conversation
📝 WalkthroughWalkthroughNew Kaizen learning mode configuration for the Roo Code extension, defining a mandatory three-step agent workflow (get_guidelines → work → save_trajectory → attempt_completion) plus tooling and setup documentation for installation and testing. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Agent
participant MCP as Kaizen-MCP
participant Repo as FileSystem/Repo
User->>Agent: Request task
Agent->>MCP: call get_guidelines(task)
MCP-->>Agent: guidelines
Agent->>Repo: read/write files, run commands, refactor
Agent->>MCP: optional create_entity/delete_entity
Agent->>MCP: call save_trajectory({trajectory, metadata})
MCP-->>Agent: confirm saved
Agent->>MCP: call attempt_completion()
MCP-->>Agent: accept completion
Agent-->>User: deliver completion result
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/integrations/roo-code/Kaizen-export.yaml`:
- Around line 62-66: Update the workflow text and example payloads so they
include the required task_id parameter whenever save_trajectory is shown: amend
the prose that currently says "Format: [{\"role\": \"user/assistant\",
\"content\": \"...\"}]" to include task_id (e.g., {"task_id":"<id>",
"trajectory":[{"role":"user","content":"..."}]}) and update every other
save_trajectory example occurrence (including the other instances noted) so they
match the tool signature save_trajectory(task_id, trajectory) exactly and will
produce valid tool calls.
- Around line 171-185: The custom instructions currently require the “full
conversation” for save_trajectory(), which contradicts the note that the agent
"cannot access conversation history"; update the doc so get_guidelines(),
attempt_completion(), and save_trajectory() expectations are consistent by
specifying how the transcript is provided (e.g., require the caller/user to
supply the final transcript or persist conversation via an external store) and
change wording to instruct the agent to prompt the user to submit the
conversation or to use the external history API; specifically update the
description and customInstructions around get_guidelines(),
attempt_completion(), and save_trajectory() to state that the agent does not
fetch history itself and must rely on an explicit user-supplied or
externally-stored transcript.
In `@docs/integrations/roo-code/SETUP_ROO_MODE.md`:
- Around line 10-16: Clarify the install path distinction: update the
instructions around "Kaizen-export.yaml" and "Custom Modes" to make the flow
conditional—if the user's Roo Code version supports YAML import, instruct them
to import Kaizen-export.yaml directly via the Roo Code settings import option
(referencing Kaizen-export.yaml and the Roo Code extension panel), otherwise
instruct them to open Kaizen-export.yaml, convert or copy the relevant fields
(slug, name, roleDefinition, customInstructions, groups) into the Custom Modes
JSON text area and then paste and save; ensure steps 2 and 6 are rewritten so
one branch describes "Import YAML" and the other describes "Copy fields and
paste JSON" to avoid implying both actions are required.
Contributor
|
Please address the coderabbit feedback. If it's not relevant, say why. |
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/integrations/roo-code/SETUP_ROO_MODE.md (1)
10-16: Clarify YAML import vs manual/JSON path to avoid conflicting steps.Steps 2 and 6 still read like both actions are required, which can confuse users. Make the instructions conditional (YAML import or manual/JSON paste), and adjust step 6 accordingly.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/integrations/roo-code/SETUP_ROO_MODE.md` around lines 10 - 16, The steps currently imply both importing Kaizen-export.yaml and manually copying fields; change Step 2 to clearly present a choice: either import the Kaizen-export.yaml file into Roo Code OR manually copy the fields (slug, name, roleDefinition, customInstructions, groups) / paste JSON into a new Custom Mode, and update Step 6 to only instruct pasting into the Custom Modes text area when the user chose the manual/JSON path (omit that step for the YAML import path); edit the wording for "import vs manual/JSON" to use explicit "OR" language and reference the Kaizen-export.yaml and Custom Modes UI so users know which single path to follow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/integrations/roo-code/SETUP_ROO_MODE.md`:
- Around line 10-16: The steps currently imply both importing Kaizen-export.yaml
and manually copying fields; change Step 2 to clearly present a choice: either
import the Kaizen-export.yaml file into Roo Code OR manually copy the fields
(slug, name, roleDefinition, customInstructions, groups) / paste JSON into a new
Custom Mode, and update Step 6 to only instruct pasting into the Custom Modes
text area when the user chose the manual/JSON path (omit that step for the YAML
import path); edit the wording for "import vs manual/JSON" to use explicit "OR"
language and reference the Kaizen-export.yaml and Custom Modes UI so users know
which single path to follow.
Collaborator
Author
comments addressed. |
Collaborator
Author
|
ready to be reviewed. |
vinodmut
approved these changes
Feb 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
Kaizen-export.yamlandSETUP_ROO_MODE.mdto provide instructions for using the Kaizen custom mode in Roo Code.Summary by CodeRabbit
New Features
Documentation