Image Generation Provider Plugins
Image Generation مزوّدو النماذج Plugins
Start with meaning, then move to detail.
This lesson explains Image Generation Provider Plugins 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 How discovery works, Directory structure, The ImageGenProvider ABC, then verify failure modes and version compatibility.
Know Python, Git, and basic project structure before changing code.
A clear outcome before you read.
- Understand Image Generation Provider Plugins 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.
- Provider
- The service that runs or provides access and authentication to a model.
How to build an image-generation backend plugin for Hermes Agent
What does the source say, and in what order?
- 01How discovery works
Start here to understand the core idea or structure.
- 02Directory structure
Read this after the foundation, then connect it to the previous step.
- 03The ImageGenProvider ABC
Read this after the foundation, then connect it to the previous step.
- 04plugin.yaml
Read this after the foundation, then connect it to the previous step.
- 05ABC reference
Read this after the foundation, then connect it to the previous step.
- 06Response format
Read this after the foundation, then connect it to the previous step.
- 07Handling base64 vs URL output
Read this after the foundation, then connect it to the previous step.
- 08User overrides
Read this after the foundation, then connect it to the previous step.
- 09Testing
Read this after the foundation, then connect it to the previous step.
- 10Reference implementations
Finish here to verify the result and special cases.
Copy only after you understand the effect.
plugins/image_gen/my-backend/
├── __init__.py # ImageGenProvider subclass + register()
└── plugin.yaml # Manifest with kind: backend## plugin.yaml`kind: backend` is what routes the plugin to the image-gen registration path. `requires_env` is prompted during `hermes plugins install`.
## ABC reference
Full contract in `agent/image_gen_provider.py`. The methods you'll typically override:
| Member | Required | Default | Purpose |
|---|---|---|---|
| `name` | ✅ | — | Stable id used in `image_gen.provider` config |
| `display_name` | — | `name.title()` | Label shown in `hermes tools` |
| `is_available()` | — | `True` | Gate for missing creds/deps |
| `list_models()` | — | `[]` | Catalog for `hermes tools` model picker |
| `default_model()`Read 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.