开始使用

快速开始

下面用一个“摘要助手”走通最小闭环。示例只依赖文本输入;带附件或已获授权扩展的 Agent 也沿用同一开发与验收骨架。请先完成最小版本,再逐项增加当前 Workspace 真实开放且能够实测的能力。

目标结果

用户输入一段文字,Agent 返回要点摘要;缺少正文时给出可执行的补充提示。开发阶段在 WebChat 验证,发布后再手动 Go Online。

一条主路径完成开发

  1. 登录官网并创建草稿

    打开 OpenAgent 官网,登录后进入 Developer,点击 Create。系统会创建 Agent 与首个 draft,并打开版本工作台。
  2. 设置版本号

    输入类似 0.1.0 的版本号。格式必须是 N.N.N,每段只能有 1–2 位数字,例如 1.0.012.3.45v1.0.01.0100.0.0 都不合法。
  3. 复制本地构建提示词

    点击 Build With Local Agent,复制弹窗中的全部内容。它包含固定 Skill URL、operation=build 以及当前 agent_idagent_version_id。不要节选、改写或替换其中的值。
  4. 原样粘贴给本地 AI

    本地 AI 应先读取 Skill,再使用 Skill 内绑定的下载地址与 SHA-256 安装 CLI 0.7.3 或更新版本。不要另找 CLI 下载地址,也不要改用未校验的 curlwget 或原始平台 API。
  5. 完成只读诊断并选择来源

    运行 oasn-sa-dev doctoroasn-sa-dev workspace sources --version-id <agent_version_id>。在续用已有 Workspace、指定已发布版本快照或 --fresh 基础环境之间明确选择;推荐来源不能替代你的确认。
  6. 创建并连接 Workspace

    按已确认来源运行带 --source-version-id--freshworkspace create。返回 active 后再运行 workspace connect --workspace-id <ID>;只有 ssh_binding_status=boundssh_verified=true 才使用返回的 SSH/SCP 命令。
  7. /oasn 实现最小 Program

    使用 connect 返回的完整 SSH/SCP 命令,不自行拼 host、端口、用户名或密钥参数。为摘要助手定义清楚:读取用户正文;有内容时输出标题和 3–5 个要点;正文为空时说明需要什么输入。若开发 WebUI,先用 version webui-ports set 声明完整端口列表,再按 结构化输入与 WebUI JSON 实现。
  8. 在 WebChat 做两次最小验证

    打开 CLI 返回的 webchat_url:一次输入正常长文本,检查摘要是否忠实;一次不提供正文,检查 Agent 是否给出明确补充提示。不要只以“对话有回复”作为通过标准。
  9. 补齐版本配置并保存

    回到官网填写头像、名称、描述、类别和 MOM,选择必需的 LLM 能力,设置 CPU/内存及定价;Gross margin 使用 0–100 的整数百分比。点击 Save Draft,确认页面没有未保存状态或校验错误。
  10. 发布后再上线

    点击 Publish,等待 Job 为 succeeded 且 publication 为 visible。新发布版本默认是 Offline;检查版本摘要后点击 Go Online。然后打开发布完成结果给出的公开 Agent 链接;若页面未显示该链接,就进入官网公开 Agents 列表,按 Agent 的准确名称搜索并核对后打开。点击 Use in ChatGPT,或展开右侧菜单选择 Use in Claude/Use in WorkBuddy,按安装弹窗完成接入。安装完成后,还要在客户端按准确名称找到当前 Agent,核对说明和开发者身份,再提交一次代表性请求并检查最终输出。
Build With Local Agent 弹窗展示完整可信提示词
复制完整提示词。 固定 Skill URL 与当前 Agent/版本 ID 共同构成可信上下文;截图中的 ID 为脱敏示例。

Workspace 返回什么才算成功

创建或查询成功时,CLI 输出 JSON。开发前至少核对以下字段:

{
  "workspace_id": "<workspace-id>",
  "version_id": "<agent-version-id>",
  "status": "active",
  "connection_status": "ready",
  "ssh_binding_status": "bound",
  "ssh_verified": true,
  "remote_project_dir": "/oasn",
  "webchat_url": "https://...",
  "webui_urls": [],
  "ssh_command": "ssh ...",
  "scp_command": "scp ...",
  "expires_at": "..."
}

active 之后还要完成连接验证

如果出现 WORKSPACE_TIMEOUT,保存错误里的 workspace_id,再运行 workspace status;不要重新 create。active 只允许进入 connect 阶段,不证明 SSH 已可用;以 bound + ssh_verified=true 为连接完成门。

最小验收清单

  • 版本号符合 N.N.N,且编辑的是预期 draft。
  • 本地 AI 使用官网复制的完整提示词,没有重新猜测或索要 ID。
  • CLI 0.7.3 或更新版本经过 Skill 中的 URL、大小、响应头摘要与正文摘要校验后安装。
  • 已明确选择来源;Workspace 为 active,connect 返回 bound + ssh_verified=true,所有连接信息直接取自本次 CLI 输出。
  • 正常输入与缺失输入都验证过,并核对了内容而非只看 HTTP/对话成功。
  • Agent Card、MOM、模型、CPU/Memory 和 Pricing 均通过工作台校验。
  • 发布成功后完成 Go Online,从公开 Agent 页安装到实际客户端,并完成一次正式调用验收;找不到公开页或无法安装时记录为 BLOCKED/NOT TESTED,而不是通过。

下一步可按需深入:编写 Program开发测试发布与上线

搜索文档

推荐搜索