agent-fleet/openspec/changes/agent-onboarding-docs/proposal.md
Zer4tul d1a746a8cb docs: add agent API reference, onboarding guide, and universal skill
- docs/agent-api-reference.md (473 lines): complete HTTP API reference for all 12 endpoints
- docs/agent-onboarding-guide.md (272 lines): ssh_cli and http_pull workflows, Forgejo integration
- skill/SKILL.md (281 lines): universal agent skill, platform-agnostic, curl-based examples

All content in English. No code changes.
2026-05-12 14:57:05 +08:00

37 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Why
agent-fleet 的所有核心功能双执行模型、Forgejo 集成、Receipt 验证)已经实现并在 arm0 上跑通。但没有任何 Agent 知道如何使用它。
当前状态:
- API 端点已经实现注册、心跳、dequeue、status、receipt、webhook 等)
- 双执行模式ssh_cli + http_pull已经实现
- 但没有任何文档告诉 Agent "怎么接入、怎么调 API、怎么配合工作流"
项目的可用性完全取决于 Agent 能否正确接入。没有文档和 skillagent-fleet 就是一个没人会用的 API。
同时,需要的是一个**通用 skill**(不绑定 OpenClaw因为
- 承担 Team Leader 角色的不一定是 OpenClaw
- Codex、Claude Code、OpenCode、Hermes Agent 等都需要能理解和使用 agent-fleet
- Skill 是通用的 Agent 能力描述,遵循通用规范
## What Changes
- 新增 `docs/agent-api-reference.md`:完整的 HTTP API 参考文档,供任何 Agent 阅读
- 新增 `docs/agent-onboarding-guide.md`Agent 接入指南,包含两种模式的完整工作流程
- 新增 `skill/` 目录:通用 Agent Skill 定义SKILL.md遵循通用 skill 规范
- Skill 内容API 调用方式、认证、任务生命周期、Forgejo 工作流、错误处理
## Capabilities
### New Capabilities
- `agent-api-reference`: HTTP API 完整参考文档(端点、请求/响应格式、错误码、示例)
- `agent-skill`: 通用 Agent Skill 定义,描述 Agent 如何与 agent-fleet 交互
### Modified Capabilities
_(无)_
## Impact
- **文档**:新增 2 个 Markdown 文档 + 1 个 Skill 定义
- **代码**:无代码变更
- **项目**Skill 目录是新增结构,可能需要考虑放在 repo 的哪个位置