跳到主要内容

创建技能

技能是为 Hermes Agent 添加新能力的首选方式。它们比工具更容易创建,无需修改 Agent 代码,并且可以与社区共享。

应该做成技能还是工具?

当以下情况时,做成技能

  • 该能力可以表达为指令 + shell 命令 + 现有工具的组合
  • 它封装了一个外部 CLI 或 API,Agent 可以通过 terminalweb_extract 调用
  • 它不需要自定义 Python 集成或内置于 Agent 的 API 密钥管理
  • 示例:arXiv 搜索、git 工作流、Docker 管理、PDF 处理、通过 CLI 工具发送邮件

当以下情况时,做成工具

  • 它需要与 API 密钥、认证流程或多组件配置进行端到端集成
  • 它需要每次精确执行的自定义处理逻辑
  • 它处理二进制数据、流式数据或实时事件
  • 示例:浏览器自动化、TTS、视觉分析

技能目录结构

内置技能位于 skills/ 目录下,按类别组织。官方可选技能使用相同的结构,位于 optional-skills/

skills/
├── research/
│ └── arxiv/
│ ├── SKILL.md # 必需:主指令
│ └── scripts/ # 可选:辅助脚本
│ └── search_arxiv.py
├── productivity/
│ └── ocr-and-documents/
│ ├── SKILL.md
│ ├── scripts/
│ └── references/
└── ...

SKILL.md 格式

---
name: my-skill
description: 简短描述(显示在技能搜索结果中)
version: 1.0.0
author: 你的名字
license: MIT
platforms: [macos, linux] # 可选 — 限制特定操作系统平台
# 有效值:macos, linux, windows
# 省略则所有平台加载(默认)
metadata:
hermes:
tags: [Category, Subcategory, Keywords]
related_skills: [other-skill-name]
requires_toolsets: [web] # 可选 — 仅当这些工具集激活时显示
requires_tools: [web_search] # 可选 — 仅当这些工具可用时显示
fallback_for_toolsets: [browser] # 可选 — 当这些工具集激活时隐藏
fallback_for_tools: [browser_navigate] # 可选 — 当这些工具存在时隐藏
config: # 可选 — 技能所需的 config.yaml 设置
- key: my.setting
description: "此设置控制的内容"
default: "合理的默认值"
prompt: "设置时显示的提示"
required_environment_variables: # 可选 — 技能所需的环境变量
- name: MY_API_KEY
prompt: "输入你的 API 密钥"
help: "在 https://example.com 获取"
required_for: "API 访问"
---

# 技能标题

简要介绍。

## 何时使用
触发条件 — Agent 何时应加载此技能?

## 快速参考
常用命令或 API 调用的表格。

## 操作步骤
Agent 遵循的逐步指令。

## 常见陷阱
已知的失败模式及处理方法。

## 验证
Agent 如何确认操作成功。

平台特定技能

技能可以通过 platforms 字段限制在特定操作系统上运行:

platforms: [macos]            # 仅 macOS(例如 iMessage、Apple Reminders)
platforms: [macos, linux] # macOS 和 Linux
platforms: [windows] # 仅 Windows

设置后,该技能在不兼容的平台上会自动从系统提示、skills_list() 和斜杠命令中隐藏。如果省略或留空,技能会在所有平台上加载(向后兼容)。

条件技能激活

技能可以声明对特定工具或工具集的依赖。这控制技能是否在给定会话的系统提示中显示。

metadata:
hermes:
requires_toolsets: [web] # 如果 web 工具集未激活则隐藏
requires_tools: [web_search] # 如果 web_search 工具不可用则隐藏
fallback_for_toolsets: [browser] # 如果 browser 工具集已激活则隐藏
fallback_for_tools: [browser_navigate] # 如果 browser_navigate 工具可用则隐藏
字段行为
requires_toolsets任意列出的工具集不可用时,技能隐藏
requires_tools任意列出的工具不可用时,技能隐藏
fallback_for_toolsets任意列出的工具集可用时,技能隐藏
fallback_for_tools任意列出的工具可用时,技能隐藏

fallback_for_* 的使用场景: 创建一个在主工具不可用时作为替代方案的技能。例如,一个 duckduckgo-search 技能设置了 fallback_for_tools: [web_search],仅当 web 搜索工具(需要 API 密钥)未配置时才会显示。 requires_* 的使用场景: 创建一个只有在特定工具存在时才有意义的技能。例如,一个带有 requires_toolsets: [web] 的网页抓取工作流技能,在网页工具被禁用时不会使提示变得杂乱。

环境变量要求

技能可以声明它们所需的环境变量。当通过 skill_view 加载技能时,其所需变量会自动注册,以便透传到沙盒执行环境(terminal、execute_code)。

required_environment_variables:
- name: TENOR_API_KEY
prompt: "Tenor API key" # 提示用户时显示
help: "Get your key at https://tenor.com" # 帮助文本或 URL
required_for: "GIF search functionality" # 需要此变量的功能

每个条目支持:

  • name(必需)— 环境变量名称
  • prompt(可选)— 向用户询问值时的提示文本
  • help(可选)— 获取值的帮助文本或 URL
  • required_for(可选)— 描述哪个功能需要此变量

用户也可以在 config.yaml 中手动配置透传变量:

terminal:
env_passthrough:
- MY_CUSTOM_VAR
- ANOTHER_VAR

有关仅适用于 macOS 的技能示例,请参阅 skills/apple/

加载时的安全设置

当技能需要 API 密钥或令牌时,请使用 required_environment_variables。缺失的值不会隐藏该技能使其不被发现。相反,当技能在本地 CLI 中加载时,Hermes 会安全地提示用户提供这些值。

required_environment_variables:
- name: TENOR_API_KEY
prompt: Tenor API 密钥
help: 从 https://developers.google.com/tenor 获取密钥
required_for: 完整功能

用户可以跳过设置并继续加载技能。Hermes 永远不会向模型暴露原始的密钥值。网关和消息会话会显示本地设置指引,而不是在对话中收集密钥。

沙箱透传

当你的技能被加载时,任何已声明的 required_environment_variables 中已设置的变量,都会自动透传execute_codeterminal 沙箱中——包括 Docker 和 Modal 等远程后端。你的技能脚本可以直接访问 $TENOR_API_KEY(或在 Python 中使用 os.environ["TENOR_API_KEY"]),用户无需额外配置。详情请参阅环境变量透传

旧版 prerequisites.env_vars 仍作为向后兼容的别名得到支持。

配置设置 (config.yaml)

技能可以声明非机密设置,这些设置存储在 config.yamlskills.config 命名空间下。与环境变量(作为机密存储在 .env 中)不同,配置设置用于路径、偏好设置和其他非敏感值。

metadata:
hermes:
config:
- key: myplugin.path
description: 插件数据目录的路径
default: "~/myplugin-data"
prompt: 插件数据目录路径
- key: myplugin.domain
description: 插件运行的领域
default: ""
prompt: 插件领域(例如 AI/ML 研究)

每个条目支持以下字段:

  • key(必填)—— 设置的 dotpath 路径(例如 myplugin.path
  • description(必填)—— 说明该设置控制什么
  • default(可选)—— 用户未配置时的默认值
  • prompt(可选)—— 在 hermes config migrate 期间显示的提示文本;未设置时回退到 description

工作原理:

  1. 存储: 值会被写入 config.yamlskills.config.<key> 路径下:

    skills:
    config:
    myplugin:
    path: ~/my-data
  2. 发现: hermes config migrate 会扫描所有已启用的技能,找到未配置的设置并提示用户。这些设置也会出现在 hermes config show 的"技能设置"部分。

  3. 运行时注入: 当技能加载时,其配置值会被解析并追加到技能消息中:

    [技能配置(来自 ~/.hermes/config.yaml):
    myplugin.path = /home/user/my-data
    ]

    Agent 无需自行读取 config.yaml 即可看到配置好的值。

  4. 手动设置: 用户也可以直接设置值:

    hermes config set skills.config.myplugin.path ~/my-data
何时使用哪种方式

对于 API 密钥、令牌和其他机密信息(存储在 ~/.hermes/.env 中,永远不会展示给模型),请使用 required_environment_variables。对于路径、偏好设置和非敏感设置(存储在 config.yaml 中,可在配置展示中看到),请使用 config

凭证文件要求(OAuth 令牌等)

使用 OAuth 或基于文件的凭证的技能可以声明需要挂载到远程沙箱中的文件。这适用于以文件形式存储的凭证(而非环境变量)——通常是设置脚本生成的 OAuth 令牌文件。

required_credential_files:
- path: google_token.json
description: Google OAuth2 令牌(由设置脚本创建)
- path: google_client_secret.json
description: Google OAuth2 客户端凭据

每个条目支持:

  • path(必需)——相对于 ~/.hermes/ 的文件路径
  • description(可选)——说明文件是什么以及如何创建

加载时,Hermes 会检查这些文件是否存在。缺失的文件会触发 setup_needed。已存在的文件会自动:

  • 挂载到 Docker 容器中,作为只读绑定挂载
  • 同步到 Modal 沙箱(在创建时 + 每个命令之前,因此会话中的 OAuth 可以正常工作)
  • 本地 后端可用,无需特殊处理
何时使用哪种方式

对于简单的 API 密钥和令牌(存储在 ~/.hermes/.env 中的字符串),使用 required_environment_variables。对于 OAuth 令牌文件、客户端密钥、服务账号 JSON、证书或任何磁盘上的凭据文件,使用 required_credential_files

有关同时使用两者的完整示例,请参阅 skills/productivity/google-workspace/SKILL.md

技能指南

无外部依赖

优先使用 stdlib Python、curl 和现有的 Hermes 工具(web_extractterminalread_file)。如果需要依赖项,请在技能中记录安装步骤。

渐进式展示

将最常见的工作流程放在前面。边缘情况和高级用法放在底部。这样可以为常见任务节省令牌用量。

包含辅助脚本

对于 XML/JSON 解析或复杂逻辑,请在 scripts/ 中包含辅助脚本——不要指望 LLM 每次都内联编写解析器。

从 SKILL.md 中引用打包脚本

当技能被加载时,激活消息会将技能绝对目录暴露为 [Skill directory: /abs/path],同时还会在 SKILL.md 正文中替换两个模板标记:

标记替换为
${HERMES_SKILL_DIR}技能目录的绝对路径
${HERMES_SESSION_ID}当前会话 ID(如果没有会话则保留原样)

因此,SKILL.md 可以直接告诉 Agent 运行打包脚本:

要分析输入,请运行:

node ${HERMES_SKILL_DIR}/scripts/analyse.js <input>

Agent 会看到替换后的绝对路径,并直接调用 terminal 工具执行一条可直接运行的命令——无需路径计算,也无需额外的 skill_view 往返。在 config.yaml 中设置 skills.template_vars: false 可全局禁用替换。

内联 Shell 代码片段(可选启用)

技能还可以在 SKILL.md 正文中嵌入内联 shell 代码片段,写法为 !`cmd`。启用后,每个片段的 stdout 会在 Agent 读取消息之前内联到消息中,这样技能就可以注入动态上下文:

当前日期:!`date -u +%Y-%m-%d`
Git 分支:!`git -C ${HERMES_SKILL_DIR} rev-parse --abbrev-ref HEAD`

此功能默认关闭——SKILL.md 中的任何代码片段都会在主机上未经批准直接运行,因此请仅对您信任的技能来源启用它:

# config.yaml
skills:
inline_shell: true
inline_shell_timeout: 10 # 每个片段超时秒数

代码片段以技能目录作为工作目录运行,输出限制为 4000 个字符。失败情况(超时、非零退出)会显示为简短的 [inline-shell error: ...] 标记,而不会导致整个技能崩溃。

测试技能

运行技能,验证 Agent 是否正确遵循指令:

hermes chat --toolsets skills -q "Use the X skill to do Y"

技能应该放在哪里?

内置技能(位于 skills/ 目录)随每个 Hermes 安装包一起提供。它们应该对大多数用户有广泛用途

  • 文档处理、网络调研、常见开发工作流、系统管理
  • 被广泛用户定期使用

如果你的技能是官方且有用,但并非普遍需要(例如付费服务集成、重量级依赖),请将其放在 optional-skills/ 中——它随仓库一起提供,可通过 hermes skills browse 发现(标记为“official”),并以内置信任安装。

如果你的技能是专业化的、社区贡献的或小众的,它更适合放在 Skills Hub 中——上传到注册表并通过 hermes skills install 分享。

发布技能

发布到 Skills Hub

hermes skills publish skills/my-skill --to github --repo owner/repo

发布到自定义仓库

将你的仓库添加为 tap:

hermes skills tap add owner/repo

用户随后可以从你的仓库搜索和安装。

安全扫描

所有从 Hub 安装的技能都会经过安全扫描器检查以下内容:

  • 数据泄露模式
  • 提示注入尝试
  • 破坏性命令
  • Shell 注入

信任级别:

  • builtin — 随 Hermes 提供(始终信任)
  • official — 来自仓库中的 optional-skills/(内置信任,无第三方警告)
  • trusted — 来自 openai/skills、anthropics/skills
  • community — 非危险发现可通过 --force 覆盖;dangerous 判定仍被阻止 Hermes 现在可以从多种外部发现模型消费第三方技能:
  • 直接使用 GitHub 标识符(例如 openai/skills/k8s
  • skills.sh 标识符(例如 skills-sh/vercel-labs/json-render/json-render-react
  • /.well-known/skills/index.json 提供的知名端点

如果你希望你的技能无需特定于 GitHub 的安装器即可被发现,可以考虑除了在仓库或市场中发布之外,还通过知名端点来提供它们。