Hermes BibleUnofficial Docs
← All docs Docs / Developer Guide

Adding a Platform Adapter

Adding a Platform Adapter This guide covers adding a new messaging platform to the Hermes gateway. A platform adapter connects Hermes to an external messaging s

Developer Guide
Section
Developer Guide
Source
hermesbible.com/docs/developer-guide/adding-platform-adapters

Adding a Platform Adapter This guide covers adding a new messaging platform to the Hermes gateway. A platform adapter connects Hermes to an external messaging s

Excerpt from the official Hermes Agent documentation, quoted for reference. View source

What this page covers

Section outline mirrored from the official Hermes Agent documentation. Follow any heading to read the complete text on the source site.

Upstream outline

  1. Architecture Overview
  2. Plugin Path (Recommended)
  3. plugin.yaml
  4. adapter.py
  5. Configuration
  6. What the Plugin System Handles Automatically
  7. Env-Driven Auto-Configuration
  8. YAML→env Config Bridge
  9. Cron Delivery
  10. Out-of-process cron delivery
  11. Surfacing Env Vars in hermes config
  12. Platform-Specific Slow-LLM UX
  13. Pattern: subclass _keep_typing to layer mid-flight UX
  14. Pattern: subclass send to route through a cache instead of sending immediately

Section map

Architecture Overview

Maps architecture overview to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Plugin Path (Recommended)

Maps plugin path (recommended) to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

plugin.yaml

Maps plugin.yaml to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

adapter.py

Maps adapter.py to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Configuration

Maps configuration to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

What the Plugin System Handles Automatically

Maps what the plugin system handles automatically to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Env-Driven Auto-Configuration

Maps env-driven auto-configuration to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

YAML→env Config Bridge

Maps yaml→env config bridge to the Developer Guide documentation path, with the source page reserved for exact commands and updates.

Implementation notes

  • Use this Developer Guide doc as a navigation page first: the local clone mirrors the source structure and links each heading back to the authoritative upstream section.
  • Primary decision areas: Architecture Overview, Plugin Path (Recommended), plugin.yaml, adapter.py, Configuration. Read those source anchors before changing installs, credentials, automation, or runtime configuration.
  • Useful search signals for this doc: adding, platform, adapter, covers, messaging. These are derived from the public title and summary so the clone remains lightweight.

Decision table

Best fitDeveloper Guide documentation

Use when you need orientation for adding a platform adapter before applying exact upstream commands.

Verify firstArchitecture Overview

Open the source anchor for Architecture Overview and confirm platform-specific requirements before changing configuration.

Escalate to sourceCommands, credentials, runtime behavior

Use the upstream page as the authority for current syntax, release changes, and security-sensitive steps.

Verification checklist

  1. Use this page to orient yourself within Developer Guide, then open the linked source page for exact current syntax.
  2. Start with the source section for Architecture Overview; do not rely on the local summary for commands or secrets.
  3. Check platform, install method, provider, and credential assumptions before changing a real environment.
  4. Review the source section for Plugin Path (Recommended) if the page involves setup, automation, messaging, or runtime behavior.
  5. After applying anything from the source, run the smallest relevant smoke test before widening scope.

Risk notes

Automation

Start with a bounded dry run, logs, and a manual stop path before enabling recurring or unattended execution.

External messages

Keep human review before sending public posts, customer messages, trading instructions, or team notifications.

Model spend

Set provider, token, and retry limits before scaling the workflow beyond a single test run.

Runtime access

Check filesystem, shell, browser, repository, and server permissions before granting the agent write access.

What this page covers

  • Core concept and where it fits in the Hermes Agent system.
  • Setup or operating context implied by the upstream page summary.
  • The source page link for full current details and updates.

Source mirror note

This page is generated from the public Hermes Bible index so the clone has the same route coverage and search surface. It stores the public title, category, summary, and source link locally; use the source page for full upstream text and updates.

Open source page