Agent SDK

Agent SDK 概述

使用 Claude Code 作为库构建生产级 AI 智能体

Claude Code SDK 已更名为 Claude Agent SDK。如果您正在从旧版 SDK 迁移，请参阅迁移指南。

构建能够自主读取文件、运行命令、搜索网页、编辑代码等的 AI 智能体。Agent SDK 为您提供与 Claude Code 相同的工具、智能体循环和上下文管理，可在 Python 和 TypeScript 中编程使用。

import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions

async def main():
    async for message in query(
        prompt="Find and fix the bug in auth.py",
        options=ClaudeAgentOptions(allowed_tools=["Read", "Edit", "Bash"])
    ):
        print(message)  # Claude reads the file, finds the bug, edits it

asyncio.run(main())

Agent SDK 包含用于读取文件、运行命令和编辑代码的内置工具，因此您的智能体无需您实现工具执行即可立即开始工作。深入快速入门或探索使用 SDK 构建的真实智能体：

快速入门

几分钟内构建一个修复 bug 的智能体

示例智能体

邮件助手、研究智能体等

开始使用

安装 SDK
设置 API 密钥
从 Console 获取 API 密钥，然后将其设置为环境变量：
export ANTHROPIC_API_KEY=your-api-key
SDK 还支持通过第三方 API 提供商进行身份验证：
- Amazon Bedrock：设置 CLAUDE_CODE_USE_BEDROCK=1 环境变量并配置 AWS 凭证
- Google Vertex AI：设置 CLAUDE_CODE_USE_VERTEX=1 环境变量并配置 Google Cloud 凭证
- Microsoft Azure：设置 CLAUDE_CODE_USE_FOUNDRY=1 环境变量并配置 Azure 凭证
有关详细信息，请参阅 Bedrock、Vertex AI 或 Azure AI Foundry 的设置指南。
除非事先获得批准，Anthropic 不允许第三方开发者为其产品（包括基于 Claude Agent SDK 构建的智能体）提供 claude.ai 登录或速率限制。请改用本文档中描述的 API 密钥身份验证方法。

运行您的第一个智能体

此示例创建一个使用内置工具列出当前目录中文件的智能体。

import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions

async def main():
    async for message in query(
        prompt="What files are in this directory?",
        options=ClaudeAgentOptions(allowed_tools=["Bash", "Glob"])
    ):
        if hasattr(message, "result"):
            print(message.result)

asyncio.run(main())

准备好构建了吗？ 按照快速入门创建一个能在几分钟内找到并修复 bug 的智能体。

功能

Claude Code 的所有强大功能都可在 SDK 中使用：

Claude Code 功能

SDK 还支持 Claude Code 基于文件系统的配置。要使用这些功能，请在选项中设置 setting_sources=["project"]（Python）或 settingSources: ['project']（TypeScript）。

功能	描述	位置
技能	在 Markdown 中定义的专门能力	`.claude/skills/SKILL.md`
斜杠命令	用于常见任务的自定义命令	`.claude/commands/*.md`
记忆	项目上下文和指令	`CLAUDE.md` 或 `.claude/CLAUDE.md`
插件	通过自定义命令、智能体和 MCP 服务器进行扩展	通过 `plugins` 选项以编程方式配置

将 Agent SDK 与其他 Claude 工具进行比较

Claude 平台提供了多种使用 Claude 构建的方式。以下是 Agent SDK 的定位：

更新日志

查看完整的更新日志，了解 SDK 更新、bug 修复和新功能：

TypeScript SDK：查看 CHANGELOG.md
Python SDK：查看 CHANGELOG.md

报告 bug

如果您在使用 Agent SDK 时遇到 bug 或问题：

TypeScript SDK：在 GitHub 上报告问题
Python SDK：在 GitHub 上报告问题

品牌指南

对于集成 Claude Agent SDK 的合作伙伴，使用 Claude 品牌是可选的。在您的产品中引用 Claude 时：

允许：

"Claude Agent"（下拉菜单中的首选名称）
"Claude"（当在已标记为"Agents"的菜单中时）
"{YourAgentName} Powered by Claude"（如果您已有智能体名称）

不允许：

"Claude Code" 或 "Claude Code Agent"
Claude Code 品牌的 ASCII 艺术或模仿 Claude Code 的视觉元素

您的产品应保持自己的品牌，不应看起来像是 Claude Code 或任何 Anthropic 产品。有关品牌合规性的问题，请联系我们的销售团队。

许可和条款

Claude Agent SDK 的使用受 Anthropic 商业服务条款约束，包括当您使用它为您自己的客户和最终用户提供产品和服务时，除非特定组件或依赖项在该组件的 LICENSE 文件中标明受不同许可证约束。

后续步骤

快速入门

构建一个能在几分钟内找到并修复 bug 的智能体

示例智能体

邮件助手、研究智能体等

TypeScript SDK

完整的 TypeScript API 参考和示例

Python SDK

完整的 Python API 参考和示例

Was this page helpful?

import asyncio from claude_agent_sdk import query, ClaudeAgentOptions async def main(): async for message in query( prompt="Find and fix the bug in auth.py", options=ClaudeAgentOptions(allowed_tools=["Read", "Edit", "Bash"]) ): print(message) # Claude reads the file, finds the bug, edits it asyncio.run(main())

开始使用

安装 SDK
设置 API 密钥
从 Console 获取 API 密钥，然后将其设置为环境变量：
export ANTHROPIC_API_KEY=your-api-key
SDK 还支持通过第三方 API 提供商进行身份验证：
- Amazon Bedrock：设置 CLAUDE_CODE_USE_BEDROCK=1 环境变量并配置 AWS 凭证
- Google Vertex AI：设置 CLAUDE_CODE_USE_VERTEX=1 环境变量并配置 Google Cloud 凭证
- Microsoft Azure：设置 CLAUDE_CODE_USE_FOUNDRY=1 环境变量并配置 Azure 凭证
有关详细信息，请参阅 Bedrock、Vertex AI 或 Azure AI Foundry 的设置指南。
除非事先获得批准，Anthropic 不允许第三方开发者为其产品（包括基于 Claude Agent SDK 构建的智能体）提供 claude.ai 登录或速率限制。请改用本文档中描述的 API 密钥身份验证方法。

运行您的第一个智能体

此示例创建一个使用内置工具列出当前目录中文件的智能体。

import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions

async def main():
    async for message in query(
        prompt="What files are in this directory?",
        options=ClaudeAgentOptions(allowed_tools=["Bash", "Glob"])
    ):
        if hasattr(message, "result"):
            print(message.result)

asyncio.run(main())

准备好构建了吗？ 按照快速入门创建一个能在几分钟内找到并修复 bug 的智能体。

功能

Claude Code 的所有强大功能都可在 SDK 中使用：

Claude Code 功能

SDK 还支持 Claude Code 基于文件系统的配置。要使用这些功能，请在选项中设置 setting_sources=["project"]（Python）或 settingSources: ['project']（TypeScript）。

功能	描述	位置
技能	在 Markdown 中定义的专门能力	`.claude/skills/SKILL.md`
斜杠命令	用于常见任务的自定义命令	`.claude/commands/*.md`
记忆	项目上下文和指令	`CLAUDE.md` 或 `.claude/CLAUDE.md`
插件	通过自定义命令、智能体和 MCP 服务器进行扩展	通过 `plugins` 选项以编程方式配置

品牌指南

对于集成 Claude Agent SDK 的合作伙伴，使用 Claude 品牌是可选的。在您的产品中引用 Claude 时：

允许：

"Claude Agent"（下拉菜单中的首选名称）

"Claude"（当在已标记为"Agents"的菜单中时）

"{YourAgentName} Powered by Claude"（如果您已有智能体名称）

不允许：

"Claude Code" 或 "Claude Code Agent"

Claude Code 品牌的 ASCII 艺术或模仿 Claude Code 的视觉元素

您的产品应保持自己的品牌，不应看起来像是 Claude Code 或任何 Anthropic 产品。有关品牌合规性的问题，请联系我们的销售团队。