开发者文档 SDK
SDK 概览
两个包,一套接口面:安装对应语言的 SDK,接好工作流脚本,即可触达整个平台——任务、记忆、知识库、MCP 与响应式状态。
两个包,一套接口面
| 包 | 运行时 | 安装 |
|---|---|---|
| allybuild-sdk | Python 3.10+ | pip install allybuild-sdk |
| @allybuild/sdk | Node.js >= 18 | npm install @allybuild/sdk |
你的第一个脚本
工作流脚本是上传到任务槽的单个文件。导出一个 run 入口、回报进度、返回结果:
def run(params: dict, reporter) -> None:
reporter.set_phase("Summarize")
summary = summarize(params["text"])
reporter.set_progress(80)
return {"summary": summary}export async function run(params: Record<string, unknown>, reporter) {
reporter.setPhase("Summarize");
const summary = await summarize(params.text);
reporter.setProgress(80);
return { summary };两种调用约定
- 函数式(推荐)——导出
run(params, reporter);starter 入口调用它并把返回的 dict 打印为结果。 - 模块级——顶层副作用在导入时执行;后台服务脚本定义
on_change(mutation, state)。
workflow 模块注入了什么
脚本运行前,workflow 模块会带着预配置的 helper 与注入环境物化到任务槽——TASK_ID、PROJECT_ID、TASK_JWT、ALLYBUILD_API_URL、解析好的 params 与 project_status。完整清单见 workflow 模块页。
下一步
- workflow 模块 — workflow.py / workflow.ts 的模块级名称与调用约定
- 任务 API — 派生、等待、编排任务并回应审批关卡
- 记忆 — 列出与语义检索运行沉淀的记忆
- 知识库 — 检索并体检项目的 OKF 知识库
- MCP — 调用项目 MCP server 暴露的工具
- 响应式状态 — 跨运行持久化的类型化响应式状态