Claude 代码 SDK
概述
使用 Claude Code SDK 构建自定义 AI 代理
为什么使用 Claude Code SDK?
Claude Code SDK 基于驱动 Claude Code 的代理框架构建,提供了构建生产就绪代理所需的所有构建块:
- 优化的 Claude 集成:自动提示缓存和性能优化
- 丰富的工具生态系统:文件操作、代码执行、网络搜索和 MCP 可扩展性
- 高级权限:对代理功能的细粒度控制
- 生产必需品:内置错误处理、会话管理和监控
您可以使用 SDK 构建什么?
以下是您可以创建的一些示例代理类型:
编码代理:
- 诊断和修复生产问题的 SRE 代理
- 审计代码漏洞的安全审查机器人
- 分类事件的值班工程助手
- 执行风格和最佳实践的代码审查代理
业务代理:
- 审查合同和合规性的法律助手
- 分析报告和预测的财务顾问
- 解决技术问题的客户支持代理
- 为营销团队提供的内容创作助手
SDK 选项
Claude Code SDK 提供多种形式以适应不同的用例:
- 无头模式 - 用于 CLI 脚本和自动化
- TypeScript SDK - 用于 Node.js 和 Web 应用程序
- Python SDK - 用于 Python 应用程序和数据科学
核心概念
身份验证
对于基本身份验证,请从 Anthropic Console 检索 Anthropic API 密钥并设置 ANTHROPIC_API_KEY
环境变量。
SDK 还支持通过第三方 API 提供商进行身份验证:
- Amazon Bedrock:设置
CLAUDE_CODE_USE_BEDROCK=1
环境变量并配置 AWS 凭据 - Google Vertex AI:设置
CLAUDE_CODE_USE_VERTEX=1
环境变量并配置 Google Cloud 凭据
有关第三方提供商的详细配置说明,请参阅 Amazon Bedrock 和 Google Vertex AI 文档。
系统提示
系统提示定义您的代理的角色、专业知识和行为。这是您指定要构建的代理类型的地方。
工具权限
通过细粒度权限控制您的代理可以使用哪些工具:
allowedTools
- 明确允许特定工具disallowedTools
- 阻止特定工具permissionMode
- 设置整体权限策略
模型上下文协议 (MCP)
通过 MCP 服务器使用自定义工具和集成扩展您的代理。这允许您连接到数据库、API 和其他外部服务。
常见用例
自动化测试和 CI/CD
创建在您的 CI/CD 管道中自动运行测试、分析结果和修复问题的代理。
代码审查和安全审计
构建审查拉取请求以查找安全漏洞、代码质量和合规性的代理。
事件响应
部署诊断生产问题、分析日志并建议修复的 SRE 代理。
文档生成
创建基于您的代码库生成和维护文档的代理。
数据分析
构建分析数据、生成报告和创建可视化的代理。
最佳实践
- 使用 JSON 输出格式进行响应的程序化解析
- 优雅地处理错误 - 检查退出代码并实现重试逻辑
- 使用会话管理在多轮对话中维护上下文
- 为长时间运行的操作实现超时
- 在发出多个请求时尊重速率限制
- 在部署到生产环境之前进行彻底测试
相关资源
- CLI 参考 - 完整的 CLI 文档
- GitHub Actions 集成 - 自动化您的 GitHub 工作流程
- MCP 文档 - 使用自定义工具扩展 Claude
- 常见工作流程 - 分步指南
- 故障排除 - 常见问题和解决方案