概述
Claude Code SDK 已更名为 Claude Agent SDK,其文档已重新组织。这一变化反映了该 SDK 在构建 AI Agent 方面的更广泛功能,不仅限于编码任务。 从 OpenAI Agents SDK 迁移?OpenAI Agents SDK 迁移指南通过一个完整的示例将每个原语映射到 Claude Agent SDK。有什么改变
迁移步骤
迁移 TypeScript 或 JavaScript 项目
1. 卸载旧包:@anthropic-ai/claude-code 更改为 @anthropic-ai/claude-agent-sdk:
@anthropic-ai/claude-code 仍在你的 package.json 中列出,请将其替换为 @anthropic-ai/claude-agent-sdk 并同时更新版本范围,例如从 "^0.0.42" 更新到 "^0.3.0"。
5. 查看破坏性变更
进行任何必要的代码更改以完成迁移。
迁移 Python 项目
1. 卸载旧包:WARNING: Skipping claude-code-sdk as it is not installed. 这是预期的,你可以继续下一步。
2. 安装新包:
claude-code-sdk 在你的 requirements.txt 或 pyproject.toml 中列出,请将其替换为 claude-agent-sdk。
3. 更新你的导入:
将所有导入从 claude_code_sdk 更改为 claude_agent_sdk:
破坏性变更
Python:ClaudeCodeOptions 重命名为 ClaudeAgentOptions
变更内容: Python SDK 类型ClaudeCodeOptions 已重命名为 ClaudeAgentOptions。
迁移:
系统提示词不再是默认值
变更内容: SDK 不再默认使用 Claude Code 的系统提示词。 迁移:设置源默认值
此默认值在 v0.1.0 中曾被短暂更改为不加载任何文件系统设置,然后已恢复,因此无需迁移操作。 当前行为: 在query() 上省略 settingSources 会加载用户、项目和本地文件系统设置,与 CLI 匹配。这包括 ~/.claude/settings.json、.claude/settings.json、.claude/settings.local.json、CLAUDE.md 文件和自定义命令。
要从文件系统设置中隔离运行,请传递 settingSources: [],或在 Python 中传递 setting_sources=[]。请参阅 使用 settingSources 控制文件系统设置 了解每个源加载的内容。
隔离对于 CI/CD 管道、已部署的应用程序、测试环境和多租户系统特别重要,其中本地自定义不应泄露。
Python SDK 0.1.59 及更早版本将空列表视为与省略该选项相同,因此在依赖
setting_sources=[] 之前请升级。请参阅 settingSources 不控制的内容 了解即使在 settingSources 为 [] 时也会读取的输入。后续步骤
- 探索 Agent SDK 概述 以了解可用功能
- 查看 TypeScript SDK 参考 以获取详细的 API 文档
- 查看 Python SDK 参考 以获取 Python 特定文档
- 了解 自定义工具 和 MCP 集成