sidebar_position: 13 title: “Browser Provider Plugins” description: “How to build a cloud browser backend plugin for Hermes Agent”

构建浏览器提供者插件

浏览器提供者插件用于注册云浏览器后端，该后端可处理处于云模式下的 browser_* 工具调用（如导航、点击、截图等）。内置的提供者——Browserbase、Browser Use 和 Firecrawl——均以插件形式存在于 plugins/browser/<name>/ 目录下。你可以通过在该目录旁创建新文件夹的方式来添加自定义插件，或覆盖现有的内置插件。: ::提示浏览器后端是 Hermes 支持的多种后端插件之一。其他类型的后端插件及其对应的 ABC 规范包括：网页搜索提供者插件（其 ABC 规范刻意与此处保持一致）、图像生成插件、视频生成插件、内存提供者插件、上下文引擎插件、机密信息源插件以及模型提供者插件。而常规的工具/钩子/CLI 插件则位于构建 Hermes 插件文档中。; ::

各组件的协同机制

浏览器提供者本身并不负责实现浏览功能，而是负责管理会话生命周期：创建远程浏览器会话、返回 CDP WebSocket 地址，以及最终终止该会话。Hermes 自带的浏览器框架（agent-browser + tools/browser_tool.py）会连接到你返回的任何 CDP 地址，并从那里控制页面操作——因此所有提供者都能免费使用完整的 browser_* 工具集。

当前启用的提供程序由 config.yaml 文件中的 browser.cloud_provider 参数指定；而 tools/browser_tool.py 中的调度器仅执行简单的注册表查询，不会针对不同的提供程序设置任何条件判断。

发现机制

Hermes 会在三个位置扫描浏览器后端插件：

内置插件 — <repo>/plugins/browser/<name>/（凡是标注了 kind: backend 的插件都会自动加载）
用户自定义插件 — ~/.hermes/plugins/browser/<name>/（需通过 plugins.enabled 或 hermes plugins enable <name> 参数手动启用）
Pip 安装插件 — 包含 hermes_agent.plugins 入口点的软件包

每个插件在调用 register(ctx) 方法时，都会执行 ctx.register_browser_provider()，从而将该插件实例添加到 agent/browser_registry.py 中的注册表中。

目录结构

plugins/browser/my-backend/
├── __init__.py     # register() entry point
├── provider.py     # BrowserProvider subclass
└── plugin.yaml     # Manifest with kind: backend and provides_browser_providers

plugin.yaml：
插件配置文件

name: browser-my-backend
version: 1.0.0
description: "My cloud browser backend. Requires MY_BACKEND_API_KEY."
author: you
kind: backend
provides_browser_providers:
  - my-backend

__init__.py：

from plugins.browser.my_backend.provider import MyBackendProvider


def register(ctx) -> None:
    ctx.register_browser_provider(MyBackendProvider())

BrowserProvider 接口规范

需实现 agent.browser_provider.BrowserProvider 接口。该接口包含三个生命周期方法以及身份验证相关功能：

from agent.browser_provider import BrowserProvider


class MyBackendProvider(BrowserProvider):
    @property
    def name(self) -> str:
        return "my-backend"          # the browser.cloud_provider config value

    @property
    def display_name(self) -> str:
        return "My Backend"          # shown in `hermes tools`

    def is_available(self) -> bool:
        """Cheap check only — env var present, dep importable.
        NO network calls: runs at tool-registration time and on every
        `hermes tools` paint."""
        return bool(os.environ.get("MY_BACKEND_API_KEY"))

    def create_session(self, task_id: str) -> dict:
        """Create a remote browser session; return the session-metadata contract."""
        session = my_api.create_browser(...)
        return {
            "session_name": f"my-backend-{task_id}",  # unique agent-browser session name
            "bb_session_id": session.id,              # provider session ID (for cleanup)
            "cdp_url": session.cdp_ws_url,            # CDP websocket URL
            "features": {"stealth": True},            # feature flags you enabled
        }

    def close_session(self, session_id: str) -> bool:
        """Terminate by provider session ID. Log-and-return-False on error —
        never raise, so the dispatcher's cleanup loop keeps moving."""
        ...

    def emergency_cleanup(self, session_id: str) -> None:
        """Best-effort teardown from atexit/signal handlers. Must not raise."""
        ...

会话元数据契约

create_session() 函数至少必须返回 session_name、bb_session_id、cdp_url 和 features 这些参数。有两个需要注意的特殊点：

bb_session_id 是一个旧版键名，为保持与 tools/browser_tool.py 的向后兼容性而原封不动保留——它存储的是您所用服务提供商的会话 ID，与具体供应商无关，因此请勿重命名。
create_session() 可能会抛出异常：若缺少凭证则会引发 ValueError，若出现网络或 API 错误则会引发 RuntimeError。调度器会将这些异常信息展示给用户。这与 close_session/emergency_cleanup 不同，后两者绝不能抛出任何异常。

可选的 external_call_id 键可用于支持托管网关计费功能。

`get_setup_schema()` —— “Hermes Tools”选择项

通过重写此函数，可使其作为“浏览器自动化”选择器中的优先选项出现，同时还会显示 API 密钥输入界面及安装钩子功能：

def get_setup_schema(self) -> dict:
    return {
        "name": "My Backend",
        "badge": "paid",
        "tag": "Cloud browser with stealth and proxies",
        "env_vars": [
            {"key": "MY_BACKEND_API_KEY",
             "prompt": "My Backend API key",
             "url": "https://mybackend.example"},
        ],
        "post_setup": "agent_browser",   # ensures local Chromium is installed (agent-browser itself resolves via npx)
    }

根据项目关于工具后端的规范：如果无法通过 hermes tools 选中并配置后端，则该任务尚未完成——“手动设置此环境变量”并不算是一种集成方式。

由用户自行配置

browser:
  cloud_provider: my-backend

参考实现

plugins/browser/ 目录下预置的三个提供程序是按复杂度由低到高排列的标准示例，分别为：firecrawl（最简单）、browser_use 以及 browserbase（具备隐身模式、代理支持及会话保持功能；当高级功能不可用时还能实现平滑降级）。请选择与自身需求最接近的版本进行复制。

检查清单

name 属性需为小写且保持不变（该值为用户输入的配置项）
is_available() 方法不得发起任何网络请求
create_session() 方法需返回完整的元数据结构（且 bb_session_id 键名必须完整保留）
close_session() / emergency_cleanup() 方法绝不能抛出异常
get_setup_schema() 方法需暴露相关环境变量，以便 hermes tools 能够配置后端服务
plugin.yaml 文件需明确标注 kind: backend 以及 provides_browser_providers 属性

Keyboard shortcuts

Hermes Agent Docs i18n