docs(contributing): document Hermes as a knowledge-layer agent#1088
docs(contributing): document Hermes as a knowledge-layer agent#1088QuantumEdu wants to merge 2 commits into
Conversation
Document Hermes as a detect-only knowledge-layer agent. Add agent section to CONTRIBUTING.md covering capabilities (StrategyMarkdownSections, StrategyMergeIntoYAML), why it matters as a reference implementation for non-coding agents, and contributing guidelines. Update Hermes row in README.md agent table with proper knowledge-layer description.
📝 WalkthroughWalkthroughThe documentation identifies Hermes as a detect-only knowledge-layer agent, describes its SOUL.md and YAML MCP integrations, documents contribution constraints, and updates the README agent table. ChangesHermes documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 227-232: Qualify the YAML preservation claims in the “YAML MCP
config” and “Why It Matters” sections: state that StrategyMergeIntoYAML
preserves user content outside the managed MCP block, while an existing managed
context7 block may be replaced or updated. Avoid wording that implies all user
configuration remains immutable.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: dc9f4a1b-4358-421c-9fa8-bb10693d3ee5
📒 Files selected for processing (2)
CONTRIBUTING.mdREADME.md
There was a problem hiding this comment.
Pull request overview
This PR updates project documentation to more clearly position Hermes as a detect-only, knowledge-layer agent in the Gentle-AI ecosystem, including its MCP YAML merge strategy and contributor-facing guidance.
Changes:
- Expands the Hermes description in the README agent table to explicitly call it a “knowledge-layer agent” and reference its YAML MCP strategy.
- Adds a dedicated “Hermes — Knowledge-Layer Agent” section to CONTRIBUTING.md describing capabilities, rationale, and contributor notes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Updates the Hermes row in the supported agents table to clarify its knowledge-layer role and YAML MCP strategy. |
| CONTRIBUTING.md | Adds a Hermes section documenting capabilities and contribution notes for the Hermes adapter/strategies. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | **Trae** | Solo-agent | Desktop app by ByteDance; `~/.trae/skills/` + OS-specific rules | | ||
| | **Pi** | Full (package-managed subagents) | `gentle-pi` harness with persona/model commands + Engram memory | | ||
| | **Hermes** | Detect-only | YAML MCP config, SOUL.md persona; install manually first | | ||
| | **Hermes** | Detect-only | Knowledge-layer agent — YAML MCP config via StrategyMergeIntoYAML, SOUL.md persona; install manually first | |
|
|
||
| ## Hermes — Knowledge-Layer Agent | ||
|
|
||
| Hermes is a detect-only agent in the Gentle-AI ecosystem. Unlike coding agents (Claude Code, OpenCode, Cursor), Hermes does not receive Gentle-AI-injected skills directories at install time, has no system prompt injection targets beyond SOUL.md, and does not support subagents. |
|
|
||
| - **SOUL.md system prompt** — injected via `StrategyMarkdownSections`, which uses marker-based insertion into existing prompt files. | ||
| - **YAML MCP config** — injected via `StrategyMergeIntoYAML`, which merges MCP server blocks into `config.yaml` without overwriting user configuration. | ||
| - **Skills directory** — Gentle-AI recognizes `~/.hermes/skills/` for user-managed skills. |
|
|
||
| ### Why It Matters | ||
|
|
||
| Hermes's YAML MCP strategy is the reference implementation for non-coding agents that need MCP configuration. If you are building a knowledge-layer integration (MCP servers for context, memory, or retrieval), Hermes's YAML merge strategy is the adapter pattern to follow. It demonstrates how to inject MCP configuration into a YAML-structured config file without parsing, templating, or conflicting with existing user entries. |
|
|
||
| - Hermes cannot be auto-installed. It must be installed manually before Gentle-AI detects it. | ||
| - Adapter location: `internal/agents/hermes/adapter.go` | ||
| - All `SupportTier` methods return `TierFull` for display purposes only; there is no auto-install path. |
|
I wasn't able to add the The PR body already marks Could a maintainer add the |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 47: Update the README supported-agents heading from “15 Supported Agents”
to “16 Supported Agents” to reflect the addition of Hermes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 5fcfd14a-edad-4cd9-ac1b-d4eefcafe925
📒 Files selected for processing (2)
CONTRIBUTING.mdREADME.md
| | **Trae** | Solo-agent | Desktop app by ByteDance; `~/.trae/skills/` + OS-specific rules | | ||
| | **Pi** | Full (package-managed subagents) | `gentle-pi` harness with persona/model commands + Engram memory | | ||
| | **Hermes** | Detect-only | YAML MCP config, SOUL.md persona; install manually first | | ||
| | **Hermes** | Detect-only | Knowledge-layer agent — YAML MCP config via `StrategyMergeIntoYAML`, `SOUL.md` persona; install manually first | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Update the supported-agent count.
Adding Hermes brings the table to 16 agents, but the heading still says 15 Supported Agents. Update the heading to 16 Supported Agents.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 47, Update the README supported-agents heading from “15
Supported Agents” to “16 Supported Agents” to reflect the addition of Hermes.
Closes #966
🏷️ PR Type
type:docs— Documentation only📝 Summary
Document Hermes as a detect-only knowledge-layer agent in the Gentle-AI ecosystem. Adds a new
## Hermes — Knowledge-Layer Agentsection to CONTRIBUTING.md and updates the README.md agent table with a proper knowledge-layer description.📂 Changes
CONTRIBUTING.md## Hermes — Knowledge-Layer Agentsection covering capabilities (StrategyMarkdownSections, StrategyMergeIntoYAML), why-it-matters, and contributing guidelinesREADME.md🧪 Test Plan
go test ./...)✅ Contributor Checklist
status:approvedtype:*label to this PRgo test ./...)Co-Authored-BytrailersSummary by CodeRabbit
config.yamlwithout overwriting user content outside the managed MCP section.