
software-agent-sdk
用模块化 SDK 快速搭出能干活儿的 AI Agent
software-agent-sdk 是 OpenHands 团队推出的模块化 Python SDK,用于构建 AI Agent,属于 OpenHands V1 的核心开发框架。它把 Agent 的构建过程拆解为清晰、可组合的组件,开发者无需从零搭建复杂的 Agent 运行时,就能快速接入工具调用、代码执行、多步任务规划等能力。SDK 强调简洁与模块化,让开发者可以按需替换或扩展各个模块,比如自定义工具、模型后端、执行环境等,从而适配不同业务场景。它解决的是 Agent 开发中重复造轮子、代码耦合度高、难以维护和扩展的问题,适合希望把 AI Agent 能力嵌入自身产品或做二次开发的团队。作为 OpenHands 生态的一部分,它能与 OpenHands 的运行时和工具链协同工作,降低从原型到落地的门槛。
项目数据
使用教程
环境要求
- Python 环境(SDK 为 Python 库)
- Git 用于克隆仓库
- GNU Make 用于执行 make build
- 一个可用的 LLM API Key(示例中读取 LLM_API_KEY 环境变量)
安装与启动步骤
-
1克隆仓库
从 GitHub 拉取 software-agent-sdk 源码到本地,后续所有操作都在该目录内进行。
git clone https://github.com/OpenHands/software-agent-sdk.git -
2进入项目目录
切换到刚克隆下来的仓库根目录,make build 需要在此目录执行。
cd software-agent-sdk -
3安装依赖
README 说明本地开发运行 make build,会安装 workspace 依赖与 pre-commit hooks。
make build -
4配置 API Key
示例代码通过 os.getenv("LLM_API_KEY") 读取密钥,需先设置为环境变量再运行脚本。
export LLM_API_KEY=sk-xxxxxxxx -
5运行示例脚本
把 Quick Start 代码保存为脚本后执行,即可创建 Agent 并跑通一次对话。
python quickstart.py
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
LLM_API_KEY | 是 | 模型服务密钥,示例代码通过环境变量读取 | sk-xxxxxxxx |
model | 是 | 传给 LLM 的模型名称,示例中为 gpt-5.5 | gpt-5.5 |
如何确认成功
运行示例脚本后终端打印出 All done!,且工作目录出现 FACTS.txt,即表示 Agent 已正常执行。
常见问题
Q:完整的安装步骤在哪里看?
A:README 未给出完整安装说明,仅指向官方 Getting Started Guide:https://docs.openhands.dev/sdk/getting-started,建议按该文档操作。
Q:make build 是做什么的?
A:README 说明它用于本地开发,会安装 workspace 依赖和 pre-commit hooks,适合从源码参与开发或调试的场景。
Q:必须用哪个模型?
A:示例中使用 model="gpt-5.5",只要你的 API Key 对应服务支持该模型即可,否则请换成你有权限调用的模型名。
注意事项
- README 的安装细节以外链文档为准,本教程中的命令均来自 README 原文与仓库地址推断。
- API Key 建议通过环境变量传入,不要硬编码在源码里。
- 示例中的工具(TerminalTool、FileEditorTool、TaskTrackerTool)会读写当前工作目录,注意在安全目录下运行。
核心亮点
- 模块化设计,工具、模型、执行环境等组件可独立替换和扩展
- 背靠 OpenHands 生态,能复用其运行时和工具链,降低落地成本
- Python 原生 SDK,API 清晰,适合快速原型和二次开发
不足之处
- 项目较新,文档和示例仍在完善中,部分高级用法需要读源码
- 社区规模和第三方集成数量相比成熟 Agent 框架还有差距
适用场景
- 把 AI Agent 能力嵌入自有 SaaS 产品,做自动化任务处理
- 基于 OpenHands 定制企业内部的代码生成或运维助手
- 快速搭建可调用外部工具的多步任务 Agent 原型
替代项目
LangChain、AutoGen、CrewAI
项目介绍
同类项目推荐
ComfyUI_Custom_Nodes_AlekPet
开源
给 ComfyUI 装上语音翻译和姿态检测,工作流更全能
Custom nodes that extend the capabilities of Comfyui
langchain
开源
组装 AI 应用的乐高积木,从想法到上线不换工具
The agent engineering platform.
transformers
开源
全球最大的模型仓库全家桶,想用的模型一把抓
Transformers: the model-definition framework for state-of-the-art machine learning m···
bruno
开源
把 API 测试当代码管理,用 Git 搞定协作与版本追踪
Opensource IDE For Exploring and Testing API's (lightweight alternative to Postman/I···