sidebar_position: 9 sidebar_label: "Build a Plugin" title: "Build a Hermes Plugin" description: "Step-by-step guide to building a complete Hermes plugin with tools, hooks, data files, and skills" lang: ru
Создайте плагин Hermes
В этом руководстве описывается создание полноценного плагина Hermes с нуля. К концу у вас будет работающий плагин с множеством инструментов, крючками жизненного цикла, отправленными файлами данных и набором навыков — всем, что поддерживает система плагинов.
Что вы строите
Плагин калькулятора с двумя инструментами:
- calculate — оценивать математические выражения (2**16, sqrt(144), pi * 5**2)
- unit_convert — конвертировать единицы измерения (100 F → 37.78 C, 5 km → 3.11 mi)
Плюс крючок, который регистрирует каждый вызов инструмента, и прилагаемый файл навыков.
Шаг 1: Создайте каталог плагина
mkdir -p ~/.hermes/plugins/calculator
cd ~/.hermes/plugins/calculator
Шаг 2. Напишите манифест
Создайте plugin.yaml:
name: calculator
version: 1.0.0
description: Math calculator — evaluate expressions and convert units
provides_tools:
- calculate
- unit_convert
provides_hooks:
- post_tool_call
Это говорит Гермесу: «Я плагин под названием калькулятор, я предоставляю инструменты и крючки». Поля provides_tools и provides_hooks представляют собой списки того, что регистрирует плагин.
Необязательные поля, которые вы можете добавить:
author: Your Name
requires_env: # gate loading on env vars; prompted during install
- SOME_API_KEY # simple format — plugin disabled if missing
- name: OTHER_KEY # rich format — shows description/url during install
description: "Key for the Other service"
url: "https://other.com/keys"
secret: true
Шаг 3: Напишите схемы инструментов
Создайте schemas.py — это то, что читает LLM, чтобы решить, когда вызывать ваши инструменты:
"""Tool schemas — what the LLM sees."""
CALCULATE = {
"name": "calculate",
"description": (
"Evaluate a mathematical expression and return the result. "
"Supports arithmetic (+, -, *, /, **), functions (sqrt, sin, cos, "
"log, abs, round, floor, ceil), and constants (pi, e). "
"Use this for any math the user asks about."
),
"parameters": {
"type": "object",
"properties": {
"expression": {
"type": "string",
"description": "Math expression to evaluate (e.g., '2**10', 'sqrt(144)')",
},
},
"required": ["expression"],
},
}
UNIT_CONVERT = {
"name": "unit_convert",
"description": (
"Convert a value between units. Supports length (m, km, mi, ft, in), "
"weight (kg, lb, oz, g), temperature (C, F, K), data (B, KB, MB, GB, TB), "
"and time (s, min, hr, day)."
),
"parameters": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The numeric value to convert",
},
"from_unit": {
"type": "string",
"description": "Source unit (e.g., 'km', 'lb', 'F', 'GB')",
},
"to_unit": {
"type": "string",
"description": "Target unit (e.g., 'mi', 'kg', 'C', 'MB')",
},
},
"required": ["value", "from_unit", "to_unit"],
},
}
Почему схемы важны. Поле description определяет, когда LLM будет использовать ваш инструмент. Будьте конкретны в том, что он делает и когда его использовать. parameters определяет, какие аргументы передает LLM.
Шаг 4. Напишите обработчики инструментов
Создайте tools.py — это код, который фактически выполняется, когда LLM вызывает ваши инструменты:
"""Tool handlers — the code that runs when the LLM calls each tool."""
import json
import math
# Safe globals for expression evaluation — no file/network access
_SAFE_MATH = {
"abs": abs, "round": round, "min": min, "max": max,
"pow": pow, "sqrt": math.sqrt, "sin": math.sin, "cos": math.cos,
"tan": math.tan, "log": math.log, "log2": math.log2, "log10": math.log10,
"floor": math.floor, "ceil": math.ceil,
"pi": math.pi, "e": math.e,
"factorial": math.factorial,
}
def calculate(args: dict, **kwargs) -> str:
"""Evaluate a math expression safely.
Rules for handlers:
1. Receive args (dict) — the parameters the LLM passed
2. Do the work
3. Return a JSON string — ALWAYS, even on error
4. Accept **kwargs for forward compatibility
"""
expression = args.get("expression", "").strip()
if not expression:
return json.dumps({"error": "No expression provided"})
try:
result = eval(expression, {"__builtins__": {}}, _SAFE_MATH)
return json.dumps({"expression": expression, "result": result})
except ZeroDivisionError:
return json.dumps({"expression": expression, "error": "Division by zero"})
except Exception as e:
return json.dumps({"expression": expression, "error": f"Invalid: {e}"})
# Conversion tables — values are in base units
_LENGTH = {"m": 1, "km": 1000, "mi": 1609.34, "ft": 0.3048, "in": 0.0254, "cm": 0.01}
_WEIGHT = {"kg": 1, "g": 0.001, "lb": 0.453592, "oz": 0.0283495}
_DATA = {"B": 1, "KB": 1024, "MB": 1024**2, "GB": 1024**3, "TB": 1024**4}
_TIME = {"s": 1, "ms": 0.001, "min": 60, "hr": 3600, "day": 86400}
def _convert_temp(value, from_u, to_u):
# Normalize to Celsius
c = {"F": (value - 32) * 5/9, "K": value - 273.15}.get(from_u, value)
# Convert to target
return {"F": c * 9/5 + 32, "K": c + 273.15}.get(to_u, c)
def unit_convert(args: dict, **kwargs) -> str:
"""Convert between units."""
value = args.get("value")
from_unit = args.get("from_unit", "").strip()
to_unit = args.get("to_unit", "").strip()
if value is None or not from_unit or not to_unit:
return json.dumps({"error": "Need value, from_unit, and to_unit"})
try:
# Temperature
if from_unit.upper() in {"C","F","K"} and to_unit.upper() in {"C","F","K"}:
result = _convert_temp(float(value), from_unit.upper(), to_unit.upper())
return json.dumps({"input": f"{value} {from_unit}", "result": round(result, 4),
"output": f"{round(result, 4)} {to_unit}"})
# Ratio-based conversions
for table in (_LENGTH, _WEIGHT, _DATA, _TIME):
lc = {k.lower(): v for k, v in table.items()}
if from_unit.lower() in lc and to_unit.lower() in lc:
result = float(value) * lc[from_unit.lower()] / lc[to_unit.lower()]
return json.dumps({"input": f"{value} {from_unit}",
"result": round(result, 6),
"output": f"{round(result, 6)} {to_unit}"})
return json.dumps({"error": f"Cannot convert {from_unit} → {to_unit}"})
except Exception as e:
return json.dumps({"error": f"Conversion failed: {e}"})
Основные правила для кураторов:
1. Подпись: def my_handler(args: dict, **kwargs) -> str
2. Возврат: Всегда строка JSON. И успех, и ошибка.
3. Никогда не поднимайте: Перехватывайте все исключения, вместо этого возвращайте ошибку в формате JSON.
4. Принять **kwargs: Гермес может передать дополнительный контекст в будущем.
Шаг 5: Напишите регистрацию
Создайте __init__.py — это подключит схемы к обработчикам:
"""Calculator plugin — registration."""
import logging
from . import schemas, tools
logger = logging.getLogger(__name__)
# Track tool usage via hooks
_call_log = []
def _on_post_tool_call(tool_name, args, result, task_id, **kwargs):
"""Hook: runs after every tool call (not just ours)."""
_call_log.append({"tool": tool_name, "session": task_id})
if len(_call_log) > 100:
_call_log.pop(0)
logger.debug("Tool called: %s (session %s)", tool_name, task_id)
def register(ctx):
"""Wire schemas to handlers and register hooks."""
ctx.register_tool(name="calculate", toolset="calculator",
schema=schemas.CALCULATE, handler=tools.calculate)
ctx.register_tool(name="unit_convert", toolset="calculator",
schema=schemas.UNIT_CONVERT, handler=tools.unit_convert)
# This hook fires for ALL tool calls, not just ours
ctx.register_hook("post_tool_call", _on_post_tool_call)
Что делает register():
- Вызывается ровно один раз при запуске
- ctx.register_tool() помещает ваш инструмент в реестр — модель его сразу видит
- ctx.register_hook() подписывается на события жизненного цикла
- ctx.register_cli_command() регистрирует подкоманду CLI (например, hermes my-plugin <subcommand>)
- ctx.register_command() регистрирует команду косой черты в сеансе (например, /myplugin <args> внутри чата CLI/шлюза) — см. Регистрация команд косой черты ниже
- ctx.dispatch_tool(name, arguments) — вызвать любой другой инструмент (встроенный или из другого плагина) с контекстом родительского агента (одобрения, учетные данные, Task_id), подключенным автоматически. Полезно для обработчиков косой черты, которым необходимо вызвать terminal, read_file или любой другой инструмент, как если бы модель вызывала его напрямую.
- Если эта функция выходит из строя, плагин отключается, но Hermes продолжает работать нормально
dispatch_tool пример — косая черта, запускающая инструмент:
def handle_scan(ctx, argstr):
"""Implement /scan by invoking the terminal tool through the registry."""
result = ctx.dispatch_tool("terminal", {"command": f"find . -name '{argstr}'"})
return result # returned to the caller's chat UI
def register(ctx):
ctx.register_command("scan", handle_scan, help="Find files matching a glob")
Отправленный инструмент проходит через обычные конвейеры утверждения, редактирования и составления бюджета — это настоящий вызов инструмента, а не обходной путь к ним.
Шаг 6: Проверьте это
Запускаем Гермес:
hermes
В списке инструментов баннера вы должны увидеть calculator: calculate, unit_convert.
Попробуйте эти подсказки:
What's 2 to the power of 16?
Convert 100 fahrenheit to celsius
What's the square root of 2 times pi?
How many gigabytes is 1.5 terabytes?
Проверьте статус плагина:
/plugins
Выход:
Plugins (1):
✓ calculator v1.0.0 (2 tools, 1 hooks)
Окончательная структура вашего плагина
~/.hermes/plugins/calculator/
├── plugin.yaml # "I'm calculator, I provide tools and hooks"
├── __init__.py # Wiring: schemas → handlers, register hooks
├── schemas.py # What the LLM reads (descriptions + parameter specs)
└── tools.py # What runs (calculate, unit_convert functions)
Четыре файла, четкое разделение: - Манифест объявляет, что представляет собой плагин. - Схемы описывают инструменты для LLM. - Обработчики реализуют реальную логику. - Регистрация объединяет все
Что еще могут плагины?
Файлы данных корабля
Поместите любые файлы в каталог вашего плагина и прочитайте их во время импорта:
# In tools.py or __init__.py
from pathlib import Path
_PLUGIN_DIR = Path(__file__).parent
_DATA_FILE = _PLUGIN_DIR / "data" / "languages.yaml"
with open(_DATA_FILE) as f:
_DATA = yaml.safe_load(f)
Набор навыков
Плагины могут отправлять файлы навыков, которые агент загружает через skill_view("plugin:skill"). Зарегистрируйте их в своем __init__.py:
~/.hermes/plugins/my-plugin/
├── __init__.py
├── plugin.yaml
└── skills/
├── my-workflow/
│ └── SKILL.md
└── my-checklist/
└── SKILL.md
from pathlib import Path
def register(ctx):
skills_dir = Path(__file__).parent / "skills"
for child in sorted(skills_dir.iterdir()):
skill_md = child / "SKILL.md"
if child.is_dir() and skill_md.exists():
ctx.register_skill(child.name, skill_md)
Теперь агент может загружать ваши навыки, используя их имена в пространстве имен:
skill_view("my-plugin:my-workflow") # → plugin's version
skill_view("my-workflow") # → built-in version (unchanged)
Основные свойства:
- Навыки плагина доступны только для чтения — они не вводятся ~/.hermes/skills/ и не могут быть отредактированы через skill_manage.
- Навыки плагинов не перечислены в индексе <available_skills> системной подсказки — они являются явной загрузкой по согласию.
- Названия простых навыков не затрагиваются — пространство имен предотвращает конфликты со встроенными навыками.
- Когда агент загружает навык плагина, перед ним добавляется контекстный баннер пакета со списком родственных навыков из того же плагина.
:::совет Устаревший шаблон
Старый шаблон shutil.copy2 (копирование навыка в ~/.hermes/skills/) все еще работает, но создает риск конфликта имен со встроенными навыками. Предпочитайте ctx.register_skill() для новых плагинов.