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 建構的真實代理：

快速入門

在幾分鐘內建構一個修復錯誤的代理

範例代理

電子郵件助手、研究代理等

開始使用

安裝 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())

準備好建構了嗎？ 按照快速入門在幾分鐘內建立一個能找到並修復錯誤的代理。

功能

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

Claude Code 功能

SDK 也支援 Claude Code 基於檔案系統的配置。要使用這些功能，請在選項中設定 setting_sources=["project"]（Python）或 settingSources: ['project']（TypeScript）。

功能	說明	位置
Skills	以 Markdown 定義的專門能力	`.claude/skills/SKILL.md`
斜線命令	常見任務的自訂命令	`.claude/commands/*.md`
記憶	專案上下文和指令	`CLAUDE.md` 或 `.claude/CLAUDE.md`
外掛	使用自訂命令、代理和 MCP 伺服器進行擴展	透過 `plugins` 選項以程式化方式設定

將 Agent SDK 與其他 Claude 工具進行比較

Claude 平台提供多種使用 Claude 進行建構的方式。以下是 Agent SDK 的定位：

變更日誌

查看完整的變更日誌以了解 SDK 更新、錯誤修復和新功能：

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

回報錯誤

如果您在使用 Agent SDK 時遇到錯誤或問題：

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 檔案中標明受不同授權條款約束。

後續步驟

快速入門

在幾分鐘內建構一個能找到並修復錯誤的代理

範例代理

電子郵件助手、研究代理等

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())

準備好建構了嗎？ 按照快速入門在幾分鐘內建立一個能找到並修復錯誤的代理。

功能

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

Claude Code 功能

SDK 也支援 Claude Code 基於檔案系統的配置。要使用這些功能，請在選項中設定 setting_sources=["project"]（Python）或 settingSources: ['project']（TypeScript）。

功能	說明	位置
Skills	以 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 產品。如有品牌合規方面的問題，請聯繫我們的銷售團隊。