Herdr API Schema 指南一条命令导出 JSON Schema把编码智能体接入你的工具链【免费下载链接】herdrthe runtime your coding agents live on项目地址: https://gitcode.com/GitHub_Trending/her/herdrHerdr 是一个让编码智能体Coding Agent居住其中的终端运行时它把 Claude Code、Codex、Gemini CLI 等多个 AI 智能体放进各自的终端窗格统一管理与监控。更关键的是Herdr 内置了Herdr API Schema一条命令即可导出描述整个 Socket API 的 JSON Schema让你在校验、文档生成和客户端开发中直接复用这份契约把智能体工作流无缝接入自己的工具链。先认识一下 Herdr智能体的终端运行时如果你习惯了一个终端窗口跑一个 AI 助手Herdr 会把工作流升级成一个面板管 N 个助手每个工作区、标签页、窗格都是一个独立会话你还能看到每个智能体当前是空闲、工作中、被阻塞还是已完成。除了可视化界面Herdr 还暴露了一套本地 Socket API——所有界面能做的事建工作区、切标签页、读窗格输出、等待智能体结束……都可以通过请求-响应或事件订阅的方式程序化完成。而Herdr API Schema就是这套 API 的机器可读说明书。三条命令拿到 Herdr 的 JSON SchemaSchema 已经内置在 Herdr 二进制里安装后直接用 CLI 导出即可herdr api schema # 打印简短摘要协议版本、包含的 schema 列表 herdr api schema --json # 打印完整的 JSON Schema 全文 herdr api schema --output herdr-api.schema.json # 写入文件交给工具链使用命令用途herdr api schema快速查看协议版本与 schema 清单几秒钟确认环境herdr api schema --json输出完整 JSON Schema可直接管道给jq、校验器或 AI 助手herdr api schema --output PATH落盘存档适合放进 CI 做契约测试对应的实现非常直接CLI 启动时就把 schema 文件打包进了程序src/cli/api.rs 中的include_str!保证了你导出的 schema 永远和你正在运行的二进制版本一致。Herdr API Schema 里到底有什么导出的文件遵循 JSON Schema Draft 2020-12{ $schema: https://json-schema.org/draft/2020-12/schema, protocol: 20, schema_version: 1, schemas: { request: { ...: 所有原始请求的定义 }, success_response: { ...: 成功响应 }, error_response: { ...: 错误响应 }, event: { ...: 服务器主动发出的事件 }, subscription_event: { ...: 订阅推送的事件 } } }其中request部分覆盖了全部控制面方法按领域分组如下领域典型方法工作区workspace.create、workspace.list、workspace.close标签页tab.create、tab.focus、tab.rename窗格pane.split、pane.read、pane.send_keys、pane.wait_for_output智能体agent.list、agent.prompt、agent.wait、agent.explain事件events.subscribe、events.wait插件 / 集成plugin.link、plugin.action.invoke、integration.install服务器ping、server.reload_config、server.stop完整的方法清单和参数细节可以直接查阅官方文档 socket-api.mdx中文版本见 zh-cn/socket-api.mdx。三个真实工具链场景场景一请求校验。把 schema 交给ajv、check-jsonschema或 Pydantic在脚本发出请求前先校验参数结构把拼错字段名这类低级错误挡在门外。场景二AI 辅助开发客户端。把--json的输出直接喂给编码智能体让它基于权威契约生成你所在语言的客户端代码而不是靠猜。场景三事件驱动的编排。agent.wait会一直挂到智能体完成配合events.subscribe可以实现智能体 A 完成 → 自动把结果交给智能体 B的流水线而不需要轮询。为什么这份 Schema 值得信任单一事实来源很多项目的 API 文档是手写的容易和代码脱节。Herdr 的做法恰恰相反所有请求与响应类型定义在 src/api/schema.rs通过 Rust 的schemars派生宏自动生成JSON Schemaschema 文件被声明为构建资源见 Cargo.toml随发布物一起分发升级 Herdr 后重新执行herdr api schema --output即可同步最新契约protocol字段当前为 20帮助你识别协议代际。也就是说代码改了schema 必然跟着改——这正是导出 JSON Schema 给工具链最让人安心的地方。小结你的需求推荐做法快速确认版本herdr api schema接入校验器 / 文档站herdr api schema --output herdr-api.schema.json让 AI 帮你写客户端herdr api schema --json后交给智能体只需一条命令Herdr API Schema 就把人读的文档升级成了机器可用的契约。无论你想做 CI 契约测试、IDE 插件还是智能体编排流水线这份 JSON Schema 都是最可靠的起点。【免费下载链接】herdrthe runtime your coding agents live on项目地址: https://gitcode.com/GitHub_Trending/her/herdr创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考