Adding a Platform Adapter
ربط منصة جديدة
Start with meaning, then move to detail.
This lesson explains Adding a Platform Adapter as part of Hermes internals and extension points. You will learn what it does, when it matters, and the smallest safe test that proves it works.
If you are new, do not memorize names. Focus on three questions: what problem does this solve, what access does it need, and how can you verify the result?
For practice, inspect the first example, identify its effects, run it on test data, and compare the result with the source claim.
For advanced readers, inspect Architecture Overview, Plugin Path (Recommended), plugin.yaml, then verify failure modes and version compatibility.
Know Python, Git, and basic project structure before changing code.
A clear outcome before you read.
- Understand Adding a Platform Adapter without assumed prior knowledge.
- Separate the source description from what still needs testing in your environment.
- Read the first command and identify its inputs and outputs before copying it.
Short definitions before the details.
- Gateway
- The process that connects Hermes to channels such as Telegram or Discord and routes messages.
- Automation
- Running work later or repeatedly with explicit success and failure conditions.
What does the source say, and in what order?
- 01Architecture Overview
Start here to understand the core idea or structure.
- 02Plugin Path (Recommended)
Read this after the foundation, then connect it to the previous step.
- 03plugin.yaml
Read this after the foundation, then connect it to the previous step.
- 04adapter.py
Read this after the foundation, then connect it to the previous step.
- 05Configuration
Read this after the foundation, then connect it to the previous step.
- 06What the Plugin System Handles Automatically
Read this after the foundation, then connect it to the previous step.
- 07Env-Driven Auto-Configuration
Read this after the foundation, then connect it to the previous step.
- 08YAML→env Config Bridge
Read this after the foundation, then connect it to the previous step.
- 09Cron Delivery
Read this after the foundation, then connect it to the previous step.
- 10Out-of-process cron delivery
Finish here to verify the result and special cases.
Copy only after you understand the effect.
User ↔ Messaging Platform ↔ Platform Adapter ↔ Gateway Runner ↔ AIAgent~/.hermes/plugins/my-platform/
plugin.yaml # Plugin metadata
adapter.py # Adapter class + register() entry pointname: my-platform
label: My Platform
kind: platform
version: 1.0.0
description: My custom messaging platform adapter
author: Your Name
requires_env:
- MY_PLATFORM_TOKEN # bare string works
- name: MY_PLATFORM_CHANNEL # or rich dict for better UX
description: "Channel to join"
prompt: "Channel"
password: false
optional_env:
- name: MY_PLATFORM_HOME_CHANNEL
description: "Default channel for cron delivery"
password: falseRead the first command and identify its inputs and outputs before copying it.
Match every command to your installed Hermes version, review the files and accounts it can reach, and use non-sensitive data for the first test. If this explanation differs from the source, the official source wins.