Web Search Provider Plugins
Web Search مزوّدو النماذج Plugins
Start with meaning, then move to detail.
This lesson explains Web Search 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 WebSearchProvider 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 Web Search 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.
- Tool
- A structured action the agent can call to read or change something.
How to build a web-search/extract/crawl 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 WebSearchProvider 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 shape
Read this after the foundation, then connect it to the previous step.
- 07Capability flags
Read this after the foundation, then connect it to the previous step.
- 08How Hermes wires it into the tools
Read this after the foundation, then connect it to the previous step.
- 09Lazy-installing optional dependencies
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/web/my-backend/
├── __init__.py # register() entry point
├── provider.py # WebSearchProvider subclass
└── plugin.yaml # Manifest with kind: backend and provides_web_providers## plugin.yaml| Key | Purpose |
|---|---|
| `kind: backend` | Routes the plugin through the backend-loading path |
| `provides_web_providers` | List of provider `name`s this plugin registers — used by the loader to advertise the plugin in `hermes tools` even before `register()` runs |
| `requires_env` | Interactive credential prompt during `hermes plugins install` (see [Build a Hermes Plugin](/developer-guide/plugins#gate-on-environment-variables) for the rich format) |
## ABC reference
Full contract in `agent/web_search_provider.py`. Methods you may override:
| Member | Required | Default | Purpose |
|-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.