Loading...
    0
    • 开发者指南
    • API 参考
    • MCP
    • 资源
    • 发布说明
    Search...
    ⌘K
    快速开始
    Claude 简介快速入门
    模型与定价
    模型概览选择模型Claude 4.5 新功能迁移到 Claude 4.5模型弃用定价
    使用 Claude 构建
    功能概览使用 Messages API上下文窗口提示词最佳实践
    能力
    提示词缓存上下文编辑扩展思考工作量流式消息批量处理引用多语言支持Token 计数嵌入视觉PDF 支持Files API搜索结果结构化输出Google Sheets 插件
    工具
    概览如何实现工具使用Token 高效的工具使用细粒度工具流式处理Bash 工具代码执行工具程序化工具调用计算机使用工具文本编辑器工具Web 获取工具Web 搜索工具内存工具工具搜索工具
    Agent 技能
    概览快速入门最佳实践在 API 中使用技能
    Agent SDK
    概览TypeScript SDKPython SDK迁移指南
    指南
    流式输入处理权限会话管理SDK 中的结构化输出托管 Agent SDK修改系统提示词SDK 中的 MCP自定义工具SDK 中的子 AgentSDK 中的斜杠命令SDK 中的 Agent 技能跟踪成本和使用情况待办事项列表SDK 中的插件
    API 中的 MCP
    MCP 连接器远程 MCP 服务器
    第三方平台上的 Claude
    Amazon BedrockMicrosoft FoundryVertex AI
    提示词工程
    概览提示词生成器使用提示词模板提示词改进器清晰直接使用示例(多轮提示)让 Claude 思考(CoT)使用 XML 标签给 Claude 一个角色(系统提示词)预填充 Claude 的响应链接复杂提示词长上下文提示扩展思考提示
    测试与评估
    定义成功标准开发测试用例使用评估工具降低延迟
    加强防护栏
    减少幻觉提高输出一致性缓解越狱流式拒绝减少提示词泄露保持 Claude 的角色
    管理和监控
    Admin API 概览使用和成本 APIClaude Code 分析 API
    Console
    Agent SDK

    迁移到 Claude Agent SDK

    将 Claude Code TypeScript 和 Python SDK 迁移到 Claude Agent SDK 的指南

    概述

    Claude Code SDK 已重命名为 Claude Agent SDK,其文档已重新组织。这一变化反映了该 SDK 在构建超越编码任务的 AI 代理方面的更广泛功能。

    变更内容

    方面旧版本新版本
    包名称 (TS/JS)@anthropic-ai/claude-code@anthropic-ai/claude-agent-sdk
    Python 包claude-code-sdkclaude-agent-sdk
    文档位置Claude Code 文档API 指南 → Agent SDK 部分

    文档变更: Agent SDK 文档已从 Claude Code 文档移至 API 指南下的专用 Agent SDK 部分。Claude Code 文档现在专注于 CLI 工具和自动化功能。

    迁移步骤

    对于 TypeScript/JavaScript 项目

    1. 卸载旧包:

    npm uninstall @anthropic-ai/claude-code

    2. 安装新包:

    npm install @anthropic-ai/claude-agent-sdk

    3. 更新导入:

    将所有导入从 @anthropic-ai/claude-code 更改为 @anthropic-ai/claude-agent-sdk:

    // 之前
    import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-code";
    
    // 之后
    import {
      query,
      tool,
      createSdkMcpServer,
    } from "@anthropic-ai/claude-agent-sdk";

    4. 更新 package.json 依赖项:

    如果您在 package.json 中列出了该包,请更新它:

    // 之前
    {
      "dependencies": {
        "@anthropic-ai/claude-code": "^1.0.0"
      }
    }
    
    // 之后
    {
      "dependencies": {
        "@anthropic-ai/claude-agent-sdk": "^0.1.0"
      }
    }

    就这样!无需进行其他代码更改。

    对于 Python 项目

    1. 卸载旧包:

    pip uninstall claude-code-sdk

    2. 安装新包:

    pip install claude-agent-sdk

    3. 更新导入:

    将所有导入从 claude_code_sdk 更改为 claude_agent_sdk:

    # 之前
    from claude_code_sdk import query, ClaudeCodeOptions
    
    # 之后
    from claude_agent_sdk import query, ClaudeAgentOptions

    4. 更新类型名称:

    将 ClaudeCodeOptions 更改为 ClaudeAgentOptions:

    # 之前
    from claude_agent_sdk import query, ClaudeCodeOptions
    
    options = ClaudeCodeOptions(
        model="claude-sonnet-4-5"
    )
    
    # 之后
    from claude_agent_sdk import query, ClaudeAgentOptions
    
    options = ClaudeAgentOptions(
        model="claude-sonnet-4-5"
    )

    5. 查看 破坏性变更

    进行任何必要的代码更改以完成迁移。

    破坏性变更

    为了改进隔离和显式配置,Claude Agent SDK v0.1.0 为从 Claude Code SDK 迁移的用户引入了破坏性变更。在迁移前请仔细查看本部分。

    Python:ClaudeCodeOptions 重命名为 ClaudeAgentOptions

    变更内容: Python SDK 类型 ClaudeCodeOptions 已重命名为 ClaudeAgentOptions。

    迁移:

    # 之前 (v0.0.x)
    from claude_agent_sdk import query, ClaudeCodeOptions
    
    options = ClaudeCodeOptions(
        model="claude-sonnet-4-5",
        permission_mode="acceptEdits"
    )
    
    # 之后 (v0.1.0)
    from claude_agent_sdk import query, ClaudeAgentOptions
    
    options = ClaudeAgentOptions(
        model="claude-sonnet-4-5",
        permission_mode="acceptEdits"
    )

    为什么变更: 类型名称现在与"Claude Agent SDK"品牌相匹配,并在 SDK 的命名约定中提供一致性。

    系统提示不再是默认值

    变更内容: SDK 不再默认使用 Claude Code 的系统提示。

    迁移:

    // 之前 (v0.0.x) - 默认使用 Claude Code 的系统提示
    const result = query({ prompt: "Hello" });
    
    // 之后 (v0.1.0) - 默认使用空系统提示
    // 要获得旧行为,请显式请求 Claude Code 的预设:
    const result = query({
      prompt: "Hello",
      options: {
        systemPrompt: { type: "preset", preset: "claude_code" }
      }
    });
    
    // 或使用自定义系统提示:
    const result = query({
      prompt: "Hello",
      options: {
        systemPrompt: "You are a helpful coding assistant"
      }
    });

    为什么变更: 为 SDK 应用程序提供更好的控制和隔离。您现在可以构建具有自定义行为的代理,而无需继承 Claude Code 的 CLI 焦点指令。

    设置源不再默认加载

    变更内容: SDK 不再默认从文件系统设置(CLAUDE.md、settings.json、斜杠命令等)读取。

    迁移:

    // 之前 (v0.0.x) - 自动加载所有设置
    const result = query({ prompt: "Hello" });
    // 会读取:
    // - ~/.claude/settings.json (用户)
    // - .claude/settings.json (项目)
    // - .claude/settings.local.json (本地)
    // - CLAUDE.md 文件
    // - 自定义斜杠命令
    
    // 之后 (v0.1.0) - 默认不加载设置
    // 要获得旧行为:
    const result = query({
      prompt: "Hello",
      options: {
        settingSources: ["user", "project", "local"]
      }
    });
    
    // 或仅加载特定源:
    const result = query({
      prompt: "Hello",
      options: {
        settingSources: ["project"]  // 仅项目设置
      }
    });

    为什么变更: 确保 SDK 应用程序具有独立于本地文件系统配置的可预测行为。这对以下情况特别重要:

    • CI/CD 环境 - 没有本地自定义的一致行为
    • 已部署的应用程序 - 不依赖文件系统设置
    • 测试 - 隔离的测试环境
    • 多租户系统 - 防止用户之间的设置泄露

    向后兼容性: 如果您的应用程序依赖文件系统设置(自定义斜杠命令、CLAUDE.md 指令等),请将 settingSources: ['user', 'project', 'local'] 添加到您的选项中。

    为什么重命名?

    Claude Code SDK 最初是为编码任务设计的,但它已演变成一个强大的框架,用于构建所有类型的 AI 代理。新名称"Claude Agent SDK"更好地反映了其功能:

    • 构建业务代理(法律助手、财务顾问、客户支持)
    • 创建专门的编码代理(SRE 机器人、安全审查员、代码审查代理)
    • 为任何领域开发自定义代理,具有工具使用、MCP 集成等功能

    获取帮助

    如果您在迁移过程中遇到任何问题:

    对于 TypeScript/JavaScript:

    1. 检查所有导入是否已更新为使用 @anthropic-ai/claude-agent-sdk
    2. 验证您的 package.json 具有新的包名称
    3. 运行 npm install 以确保依赖项已更新

    对于 Python:

    1. 检查所有导入是否已更新为使用 claude_agent_sdk
    2. 验证您的 requirements.txt 或 pyproject.toml 具有新的包名称
    3. 运行 pip install claude-agent-sdk 以确保包已安装

    后续步骤

    • 探索 Agent SDK 概述 以了解可用功能
    • 查看 TypeScript SDK 参考 以获取详细的 API 文档
    • 查看 Python SDK 参考 以获取 Python 特定文档
    • 了解 自定义工具 和 MCP 集成
    • 对于 TypeScript/JavaScript 项目
    • 对于 Python 项目
    • Python:ClaudeCodeOptions 重命名为 ClaudeAgentOptions

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Partners

    • Amazon Bedrock
    • Google Cloud's Vertex AI

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Help and security

    • Availability
    • Status
    • Support
    • Discord

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy