Skip to content

docs: Hermes Agent integration guide - #887

Open
jamiepine wants to merge 3 commits into
mainfrom
docs/hermes-agent-integration
Open

docs: Hermes Agent integration guide#887
jamiepine wants to merge 3 commits into
mainfrom
docs/hermes-agent-integration

Conversation

@jamiepine

@jamiepine jamiepine commented Jul 12, 2026

Copy link
Copy Markdown
Owner

Adds a new Overview docs page showing how to wire Voicebox into Hermes Agent in both directions:

  • MCPhermes mcp install voicebox (catalog entry submitted upstream) or a manual mcp_servers.voicebox block, giving the agent voicebox.speak / voicebox.transcribe / voicebox.list_profiles / voicebox.list_captures as tools it can choose to call.
  • Provider pluginhermes-voicebox registers Voicebox as Hermes's TTS and STT provider, routing its entire voice pipeline (spoken replies, Telegram/Discord voice bubbles, incoming voice-message transcription, push-to-talk) through local Voicebox.

Includes behavior notes (app-must-be-running, first-generation model load, Whisper 202 download) and Docker port differences. Page added to the Overview sidebar after MCP Server. bun run build passes with the new page compiled.

Companion PR: optional-mcps/voicebox catalog entry submitted to hermes-agent (NousResearch/hermes-agent#63498). The provider plugin itself ships standalone: hermes-voicebox (PyPI).

Summary by CodeRabbit

  • Documentation
    • Added a new “Hermes Agent” guide for integrating Voicebox as an on-device voice and transcription service.
    • Documented Voicebox’s MCP tool interface, including an example Hermes MCP configuration and clarification of how tool routing works with the existing TTS/STT pipeline.
    • Included provider plugin setup for using Voicebox as Hermes’s TTS/STT backend, covering configuration steps, Docker base URL notes, runtime/latency expectations, and security considerations.
    • Updated documentation navigation to include the new Hermes Agent page.

New overview page covering both integration surfaces: the MCP hookup
(hermes mcp install voicebox — catalog entry submitted upstream) for
agent-invoked speak/transcribe/captures tools, and the hermes-voicebox
provider plugin (github.com/jamiepine/hermes-voicebox) that routes
Hermes's entire voice pipeline — spoken replies, Telegram voice
bubbles, and incoming voice-message transcription — through local
Voicebox.
@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Adds a Hermes Agent documentation page covering Voicebox MCP tools, the hermes-voicebox provider plugin, setup instructions, runtime behavior, and related resources. Registers the page in the overview navigation metadata.

Changes

Hermes Agent documentation

Layer / File(s) Summary
Integration overview and navigation
docs/content/docs/overview/hermes-agent.mdx, docs/content/docs/overview/meta.json
Introduces the Hermes Agent page, explains Voicebox’s local voice integration, and adds the page to the overview list.
MCP integration
docs/content/docs/overview/hermes-agent.mdx
Documents MCP installation, configuration, exposed tools, and its separation from Hermes TTS/STT providers.
Provider setup and runtime behavior
docs/content/docs/overview/hermes-agent.mdx
Describes the hermes-voicebox plugin, installation and configuration, runtime requirements, model behavior, and related links.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: a Hermes Agent integration guide in docs.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/hermes-agent-integration

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/content/docs/overview/hermes-agent.mdx (1)

1-140: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Update the Hermes docs links Lines 70-72 point to https://hermes-agent.nousresearch.com/docs/developer-guide/..., which return 404. The #per-client-bindings anchor is fine; the GitHub repo links are also reachable. Point those docs links at the current Hermes docs paths.

🤖 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 `@docs/content/docs/overview/hermes-agent.mdx` around lines 1 - 140, Update the
TTS providers and transcription providers links in the provider plugin section
to use the current valid Hermes documentation paths instead of the obsolete
developer-guide URLs. Leave the per-client-bindings anchor and GitHub repository
links unchanged.
🤖 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.

Outside diff comments:
In `@docs/content/docs/overview/hermes-agent.mdx`:
- Around line 1-140: Update the TTS providers and transcription providers links
in the provider plugin section to use the current valid Hermes documentation
paths instead of the obsolete developer-guide URLs. Leave the
per-client-bindings anchor and GitHub repository links unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b7745a87-3fce-42cc-a18e-fbc0bcb5fff6

📥 Commits

Reviewing files that changed from the base of the PR and between f2cf2a7 and 126daf5.

📒 Files selected for processing (2)
  • docs/content/docs/overview/hermes-agent.mdx
  • docs/content/docs/overview/meta.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant