Agent SDK リファレンス - Python

Python Agent SDKの完全なAPIリファレンス。すべての関数、型、クラスを含みます。

​

インストール

pip install claude-agent-sdk

​

query() と ClaudeSDKClient の選択

Python SDKは、Claude Codeと対話するための2つの方法を提供します。

​

クイック比較

機能	query()	ClaudeSDKClient
セッション	毎回新しいセッションを作成	同じセッションを再利用
会話	単一の交換	同じコンテキスト内での複数の交換
接続	自動的に管理	手動制御
ストリーミング入力	✅ サポート	✅ サポート
割り込み	❌ サポートなし	✅ サポート
フック	❌ サポートなし	✅ サポート
カスタムツール	❌ サポートなし	✅ サポート
チャット続行	❌ 毎回新しいセッション	✅ 会話を維持
ユースケース	1回限りのタスク	継続的な会話

​

query() を使用する場合（毎回新しいセッション）

最適な用途:

• 会話履歴が不要な1回限りの質問
• 前の交換からのコンテキストが不要な独立したタスク
• シンプルな自動化スクリプト
• 毎回新しく始めたい場合

​

ClaudeSDKClient を使用する場合（継続的な会話）

最適な用途:

• 会話の継続 - Claudeがコンテキストを記憶する必要がある場合
• フォローアップ質問 - 前の応答に基づいて構築
• インタラクティブなアプリケーション - チャットインターフェース、REPL
• 応答駆動ロジック - 次のアクションがClaudeの応答に依存する場合
• セッション制御 - 会話ライフサイクルを明示的に管理

​

関数

​

query()

Claude Codeとの各インタラクションに対して新しいセッションを作成します。メッセージが到着するにつれてメッセージを生成する非同期イテレータを返します。query() への各呼び出しは、前のインタラクションのメモリなしで新しく開始します。

async def query(
    *,
    prompt: str | AsyncIterable[dict[str, Any]],
    options: ClaudeAgentOptions | None = None
) -> AsyncIterator[Message]

​

パラメータ

パラメータ	型	説明
prompt	str | AsyncIterable[dict]	入力プロンプト（文字列またはストリーミングモード用の非同期イテラブル）
options	ClaudeAgentOptions | None	オプションの設定オブジェクト（Noneの場合は ClaudeAgentOptions() がデフォルト）

​

戻り値

会話からメッセージを生成する AsyncIterator[Message] を返します。

​

例 - オプション付き

import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions

async def main():
    options = ClaudeAgentOptions(
        system_prompt="You are an expert Python developer",
        permission_mode='acceptEdits',
        cwd="/home/user/project"
    )

    async for message in query(
        prompt="Create a Python web server",
        options=options
    ):
        print(message)


asyncio.run(main())

​

tool()

型安全性を備えたMCPツールを定義するためのデコレータ。

def tool(
    name: str,
    description: str,
    input_schema: type | dict[str, Any]
) -> Callable[[Callable[[Any], Awaitable[dict[str, Any]]]], SdkMcpTool[Any]]

​

パラメータ

パラメータ	型	説明
name	str	ツールの一意の識別子
description	str	ツールが何をするかの人間が読める説明
input_schema	type | dict[str, Any]	ツールの入力パラメータを定義するスキーマ（以下を参照）

​

入力スキーマオプション

1. シンプルな型マッピング（推奨）:

   {"text": str, "count": int, "enabled": bool}
   

2. JSONスキーマ形式（複雑な検証用）:

   {
       "type": "object",
       "properties": {
           "text": {"type": "string"},
           "count": {"type": "integer", "minimum": 0}
       },
       "required": ["text"]
   }
   

​

戻り値

ツール実装をラップし、SdkMcpTool インスタンスを返すデコレータ関数。

​

例

from claude_agent_sdk import tool
from typing import Any

@tool("greet", "Greet a user", {"name": str})
async def greet(args: dict[str, Any]) -> dict[str, Any]:
    return {
        "content": [{
            "type": "text",
            "text": f"Hello, {args['name']}!"
        }]
    }

​

create_sdk_mcp_server()

Pythonアプリケーション内で実行されるインプロセスMCPサーバーを作成します。

def create_sdk_mcp_server(
    name: str,
    version: str = "1.0.0",
    tools: list[SdkMcpTool[Any]] | None = None
) -> McpSdkServerConfig

​

パラメータ

パラメータ	型	デフォルト	説明
name	str	-	サーバーの一意の識別子
version	str	"1.0.0"	サーバーバージョン文字列
tools	list[SdkMcpTool[Any]] | None	None	@tool デコレータで作成されたツール関数のリスト

​

戻り値

ClaudeAgentOptions.mcp_servers に渡すことができる McpSdkServerConfig オブジェクトを返します。

​

例

from claude_agent_sdk import tool, create_sdk_mcp_server

@tool("add", "Add two numbers", {"a": float, "b": float})
async def add(args):
    return {
        "content": [{
            "type": "text",
            "text": f"Sum: {args['a'] + args['b']}"
        }]
    }

@tool("multiply", "Multiply two numbers", {"a": float, "b": float})
async def multiply(args):
    return {
        "content": [{
            "type": "text",
            "text": f"Product: {args['a'] * args['b']}"
        }]
    }

calculator = create_sdk_mcp_server(
    name="calculator",
    version="2.0.0",
    tools=[add, multiply]  # Pass decorated functions
)

# Use with Claude
options = ClaudeAgentOptions(
    mcp_servers={"calc": calculator},
    allowed_tools=["mcp__calc__add", "mcp__calc__multiply"]
)

​

クラス

​

ClaudeSDKClient

複数の交換にわたって会話セッションを維持します。 これはTypeScript SDKの query() 関数が内部的にどのように機能するかのPython相当です - 会話を継続できるクライアントオブジェクトを作成します。

​

主な機能

• セッション継続性: 複数の query() 呼び出しにわたって会話コンテキストを維持
• 同じ会話: Claudeはセッション内の前のメッセージを記憶
• 割り込みサポート: 実行中のClaudeを停止できる
• 明示的なライフサイクル: セッションの開始と終了を制御
• 応答駆動フロー: 応答に反応してフォローアップを送信できる
• カスタムツール＆フック: カスタムツール（@tool デコレータで作成）とフックをサポート

class ClaudeSDKClient:
    def __init__(self, options: ClaudeAgentOptions | None = None)
    async def connect(self, prompt: str | AsyncIterable[dict] | None = None) -> None
    async def query(self, prompt: str | AsyncIterable[dict], session_id: str = "default") -> None
    async def receive_messages(self) -> AsyncIterator[Message]
    async def receive_response(self) -> AsyncIterator[Message]
    async def interrupt(self) -> None
    async def disconnect(self) -> None

​

メソッド

メソッド	説明
__init__(options)	オプションの設定でクライアントを初期化
connect(prompt)	オプションの初期プロンプトまたはメッセージストリームでClaudeに接続
query(prompt, session_id)	ストリーミングモードで新しいリクエストを送信
receive_messages()	Claudeからのすべてのメッセージを非同期イテレータとして受信
receive_response()	ResultMessageを含むまでのメッセージを受信
interrupt()	割り込み信号を送信（ストリーミングモードでのみ機能）
disconnect()	Claudeから切断

​

コンテキストマネージャーサポート

クライアントは自動接続管理のための非同期コンテキストマネージャーとして使用できます：

async with ClaudeSDKClient() as client:
    await client.query("Hello Claude")
    async for message in client.receive_response():
        print(message)

重要: メッセージを反復処理する場合、早期に終了するために break を使用することは避けてください。これはasyncioのクリーンアップの問題を引き起こす可能性があります。代わりに、反復処理を自然に完了させるか、フラグを使用して必要なものを見つけたときを追跡してください。

​

例 - 会話を継続

import asyncio
from claude_agent_sdk import ClaudeSDKClient, AssistantMessage, TextBlock, ResultMessage

async def main():
    async with ClaudeSDKClient() as client:
        # First question
        await client.query("What's the capital of France?")

        # Process response
        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(f"Claude: {block.text}")

        # Follow-up question - Claude remembers the previous context
        await client.query("What's the population of that city?")

        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(f"Claude: {block.text}")

        # Another follow-up - still in the same conversation
        await client.query("What are some famous landmarks there?")

        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(f"Claude: {block.text}")

asyncio.run(main())

​

例 - ClaudeSDKClientでのストリーミング入力

import asyncio
from claude_agent_sdk import ClaudeSDKClient

async def message_stream():
    """Generate messages dynamically."""
    yield {"type": "text", "text": "Analyze the following data:"}
    await asyncio.sleep(0.5)
    yield {"type": "text", "text": "Temperature: 25°C"}
    await asyncio.sleep(0.5)
    yield {"type": "text", "text": "Humidity: 60%"}
    await asyncio.sleep(0.5)
    yield {"type": "text", "text": "What patterns do you see?"}

async def main():
    async with ClaudeSDKClient() as client:
        # Stream input to Claude
        await client.query(message_stream())

        # Process response
        async for message in client.receive_response():
            print(message)

        # Follow-up in same session
        await client.query("Should we be concerned about these readings?")

        async for message in client.receive_response():
            print(message)

asyncio.run(main())

​

例 - 割り込みの使用

import asyncio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

async def interruptible_task():
    options = ClaudeAgentOptions(
        allowed_tools=["Bash"],
        permission_mode="acceptEdits"
    )

    async with ClaudeSDKClient(options=options) as client:
        # Start a long-running task
        await client.query("Count from 1 to 100 slowly")

        # Let it run for a bit
        await asyncio.sleep(2)

        # Interrupt the task
        await client.interrupt()
        print("Task interrupted!")

        # Send a new command
        await client.query("Just say hello instead")

        async for message in client.receive_response():
            # Process the new response
            pass

asyncio.run(interruptible_task())

​

例 - 高度なパーミッション制御

from claude_agent_sdk import (
    ClaudeSDKClient,
    ClaudeAgentOptions
)

async def custom_permission_handler(
    tool_name: str,
    input_data: dict,
    context: dict
):
    """Custom logic for tool permissions."""

    # Block writes to system directories
    if tool_name == "Write" and input_data.get("file_path", "").startswith("/system/"):
        return {
            "behavior": "deny",
            "message": "System directory write not allowed",
            "interrupt": True
        }

    # Redirect sensitive file operations
    if tool_name in ["Write", "Edit"] and "config" in input_data.get("file_path", ""):
        safe_path = f"./sandbox/{input_data['file_path']}"
        return {
            "behavior": "allow",
            "updatedInput": {**input_data, "file_path": safe_path}
        }

    # Allow everything else
    return {
        "behavior": "allow",
        "updatedInput": input_data
    }

async def main():
    options = ClaudeAgentOptions(
        can_use_tool=custom_permission_handler,
        allowed_tools=["Read", "Write", "Edit"]
    )

    async with ClaudeSDKClient(options=options) as client:
        await client.query("Update the system config file")

        async for message in client.receive_response():
            # Will use sandbox path instead
            print(message)

asyncio.run(main())

​

型

​

SdkMcpTool

@tool デコレータで作成されたSDK MCPツールの定義。

@dataclass
class SdkMcpTool(Generic[T]):
    name: str
    description: str
    input_schema: type[T] | dict[str, Any]
    handler: Callable[[T], Awaitable[dict[str, Any]]]

プロパティ	型	説明
name	str	ツールの一意の識別子
description	str	人間が読める説明
input_schema	type[T] | dict[str, Any]	入力検証用のスキーマ
handler	Callable[[T], Awaitable[dict[str, Any]]]	ツール実行を処理する非同期関数

​

ClaudeAgentOptions

Claude Codeクエリの設定データクラス。

@dataclass
class ClaudeAgentOptions:
    allowed_tools: list[str] = field(default_factory=list)
    system_prompt: str | SystemPromptPreset | None = None
    mcp_servers: dict[str, McpServerConfig] | str | Path = field(default_factory=dict)
    permission_mode: PermissionMode | None = None
    continue_conversation: bool = False
    resume: str | None = None
    max_turns: int | None = None
    disallowed_tools: list[str] = field(default_factory=list)
    model: str | None = None
    permission_prompt_tool_name: str | None = None
    cwd: str | Path | None = None
    settings: str | None = None
    add_dirs: list[str | Path] = field(default_factory=list)
    env: dict[str, str] = field(default_factory=dict)
    extra_args: dict[str, str | None] = field(default_factory=dict)
    max_buffer_size: int | None = None
    debug_stderr: Any = sys.stderr  # Deprecated
    stderr: Callable[[str], None] | None = None
    can_use_tool: CanUseTool | None = None
    hooks: dict[HookEvent, list[HookMatcher]] | None = None
    user: str | None = None
    include_partial_messages: bool = False
    fork_session: bool = False
    agents: dict[str, AgentDefinition] | None = None
    setting_sources: list[SettingSource] | None = None

プロパティ	型	デフォルト	説明
allowed_tools	list[str]	[]	許可されたツール名のリスト
system_prompt	str | SystemPromptPreset | None	None	システムプロンプト設定。カスタムプロンプト用に文字列を渡すか、Claude Codeのシステムプロンプト用に {"type": "preset", "preset": "claude_code"} を使用します。プリセットを拡張するために "append" を追加
mcp_servers	dict[str, McpServerConfig] | str | Path	{}	MCPサーバー設定または設定ファイルへのパス
permission_mode	PermissionMode | None	None	ツール使用のパーミッションモード
continue_conversation	bool	False	最新の会話を継続
resume	str | None	None	再開するセッションID
max_turns	int | None	None	最大会話ターン数
disallowed_tools	list[str]	[]	許可されていないツール名のリスト
model	str | None	None	使用するClaudeモデル
permission_prompt_tool_name	str | None	None	パーミッションプロンプト用のMCPツール名
cwd	str | Path | None	None	現在の作業ディレクトリ
settings	str | None	None	設定ファイルへのパス
add_dirs	list[str | Path]	[]	Claudeがアクセスできる追加ディレクトリ
env	dict[str, str]	{}	環境変数
extra_args	dict[str, str | None]	{}	CLIに直接渡す追加のCLI引数
max_buffer_size	int | None	None	CLI stdoutをバッファリングする場合の最大バイト数
debug_stderr	Any	sys.stderr	非推奨 - デバッグ出力用のファイルのようなオブジェクト。代わりに stderr コールバックを使用
stderr	Callable[[str], None] | None	None	CLIからのstderr出力用のコールバック関数
can_use_tool	CanUseTool | None	None	ツールパーミッションコールバック関数
hooks	dict[HookEvent, list[HookMatcher]] | None	None	イベント傍受用のフック設定
user	str | None	None	ユーザー識別子
include_partial_messages	bool	False	部分的なメッセージストリーミングイベントを含める
fork_session	bool	False	resume で再開する場合、元のセッションを継続する代わりに新しいセッションIDにフォーク
agents	dict[str, AgentDefinition] | None	None	プログラムで定義されたサブエージェント
plugins	list[SdkPluginConfig]	[]	ローカルパスからカスタムプラグインをロード。詳細は Plugins を参照
setting_sources	list[SettingSource] | None	None（設定なし）	どのファイルシステム設定をロードするかを制御。省略した場合、設定はロードされません。注: CLAUDE.mdファイルをロードするには "project" を含める必要があります

​

SystemPromptPreset

オプションの追加を伴うClaude Codeのプリセットシステムプロンプトを使用するための設定。

class SystemPromptPreset(TypedDict):
    type: Literal["preset"]
    preset: Literal["claude_code"]
    append: NotRequired[str]

フィールド	必須	説明
type	はい	プリセットシステムプロンプトを使用するには "preset" である必要があります
preset	はい	Claude Codeのシステムプロンプトを使用するには "claude_code" である必要があります
append	いいえ	プリセットシステムプロンプトに追加する追加の指示

​

SettingSource

SDKがロードする設定のファイルシステムベースの設定ソースを制御します。

SettingSource = Literal["user", "project", "local"]

値	説明	場所
"user"	グローバルユーザー設定	~/.claude/settings.json
"project"	共有プロジェクト設定（バージョン管理）	.claude/settings.json
"local"	ローカルプロジェクト設定（gitignored）	.claude/settings.local.json

​

デフォルト動作

setting_sources が 省略 または None の場合、SDKはファイルシステム設定をロード しません。これはSDKアプリケーションの分離を提供します。

​

setting_sources を使用する理由

すべてのファイルシステム設定をロード（レガシー動作）:

# SDK v0.0.x のようにすべての設定をロード
from claude_agent_sdk import query, ClaudeAgentOptions

async for message in query(
    prompt="Analyze this code",
    options=ClaudeAgentOptions(
        setting_sources=["user", "project", "local"]  # Load all settings
    )
):
    print(message)

特定の設定ソースのみをロード:

# プロジェクト設定のみをロード、ユーザーとローカルを無視
async for message in query(
    prompt="Run CI checks",
    options=ClaudeAgentOptions(
        setting_sources=["project"]  # Only .claude/settings.json
    )
):
    print(message)

テストとCI環境:

# ローカル設定を除外してCI内で一貫した動作を確保
async for message in query(
    prompt="Run tests",
    options=ClaudeAgentOptions(
        setting_sources=["project"],  # Only team-shared settings
        permission_mode="bypassPermissions"
    )
):
    print(message)

SDKのみのアプリケーション:

# すべてをプログラムで定義（デフォルト動作）
# ファイルシステムの依存関係なし - setting_sources はデフォルトで None
async for message in query(
    prompt="Review this PR",
    options=ClaudeAgentOptions(
        # setting_sources=None is the default, no need to specify
        agents={ /* ... */ },
        mcp_servers={ /* ... */ },
        allowed_tools=["Read", "Grep", "Glob"]
    )
):
    print(message)

CLAUDE.mdプロジェクト指示のロード:

# プロジェクト設定をロードしてCLAUDE.mdファイルを含める
async for message in query(
    prompt="Add a new feature following project conventions",
    options=ClaudeAgentOptions(
        system_prompt={
            "type": "preset",
            "preset": "claude_code"  # Use Claude Code's system prompt
        },
        setting_sources=["project"],  # Required to load CLAUDE.md from project
        allowed_tools=["Read", "Write", "Edit"]
    )
):
    print(message)

​

設定の優先順位

複数のソースがロードされる場合、設定は次の優先順位（高から低）でマージされます：

1. ローカル設定（.claude/settings.local.json）
2. プロジェクト設定（.claude/settings.json）
3. ユーザー設定（~/.claude/settings.json）

プログラムオプション（agents、allowed_tools など）は常にファイルシステム設定をオーバーライドします。

​

AgentDefinition

プログラムで定義されたサブエージェントの設定。

@dataclass
class AgentDefinition:
    description: str
    prompt: str
    tools: list[str] | None = None
    model: Literal["sonnet", "opus", "haiku", "inherit"] | None = None

フィールド	必須	説明
description	はい	このエージェントをいつ使用するかの自然言語説明
tools	いいえ	許可されたツール名の配列。省略した場合、すべてのツールを継承
prompt	はい	エージェントのシステムプロンプト
model	いいえ	このエージェント用のモデルオーバーライド。省略した場合、メインモデルを使用

​

PermissionMode

ツール実行を制御するためのパーミッションモード。

PermissionMode = Literal[
    "default",           # Standard permission behavior
    "acceptEdits",       # Auto-accept file edits
    "plan",              # Planning mode - no execution
    "bypassPermissions"  # Bypass all permission checks (use with caution)
]

​

McpSdkServerConfig

create_sdk_mcp_server() で作成されたSDK MCPサーバーの設定。

class McpSdkServerConfig(TypedDict):
    type: Literal["sdk"]
    name: str
    instance: Any  # MCP Server instance

​

McpServerConfig

MCPサーバー設定の共用体型。

McpServerConfig = McpStdioServerConfig | McpSSEServerConfig | McpHttpServerConfig | McpSdkServerConfig

​

McpStdioServerConfig

class McpStdioServerConfig(TypedDict):
    type: NotRequired[Literal["stdio"]]  # Optional for backwards compatibility
    command: str
    args: NotRequired[list[str]]
    env: NotRequired[dict[str, str]]

​

McpSSEServerConfig

class McpSSEServerConfig(TypedDict):
    type: Literal["sse"]
    url: str
    headers: NotRequired[dict[str, str]]

​

McpHttpServerConfig

class McpHttpServerConfig(TypedDict):
    type: Literal["http"]
    url: str
    headers: NotRequired[dict[str, str]]

​

SdkPluginConfig

SDKでプラグインをロードするための設定。

class SdkPluginConfig(TypedDict):
    type: Literal["local"]
    path: str

フィールド	型	説明
type	Literal["local"]	"local" である必要があります（現在ローカルプラグインのみサポート）
path	str	プラグインディレクトリへの絶対パスまたは相対パス

例:

plugins=[
    {"type": "local", "path": "./my-plugin"},
    {"type": "local", "path": "/absolute/path/to/plugin"}
]

プラグインの作成と使用に関する完全な情報については、Plugins を参照してください。

​

メッセージ型

​

Message

すべての可能なメッセージの共用体型。

Message = UserMessage | AssistantMessage | SystemMessage | ResultMessage

​

UserMessage

ユーザー入力メッセージ。

@dataclass
class UserMessage:
    content: str | list[ContentBlock]

​

AssistantMessage

コンテンツブロック付きのアシスタント応答メッセージ。

@dataclass
class AssistantMessage:
    content: list[ContentBlock]
    model: str

​

SystemMessage

メタデータ付きのシステムメッセージ。

@dataclass
class SystemMessage:
    subtype: str
    data: dict[str, Any]

​

ResultMessage

コストと使用情報付きの最終結果メッセージ。

@dataclass
class ResultMessage:
    subtype: str
    duration_ms: int
    duration_api_ms: int
    is_error: bool
    num_turns: int
    session_id: str
    total_cost_usd: float | None = None
    usage: dict[str, Any] | None = None
    result: str | None = None

​

コンテンツブロック型

​

ContentBlock

すべてのコンテンツブロックの共用体型。

ContentBlock = TextBlock | ThinkingBlock | ToolUseBlock | ToolResultBlock

​

TextBlock

テキストコンテンツブロック。

@dataclass
class TextBlock:
    text: str

​

ThinkingBlock

シンキングコンテンツブロック（思考能力を持つモデル用）。

@dataclass
class ThinkingBlock:
    thinking: str
    signature: str

​

ToolUseBlock

ツール使用リクエストブロック。

@dataclass
class ToolUseBlock:
    id: str
    name: str
    input: dict[str, Any]

​

ToolResultBlock

ツール実行結果ブロック。

@dataclass
class ToolResultBlock:
    tool_use_id: str
    content: str | list[dict[str, Any]] | None = None
    is_error: bool | None = None

​

エラー型

​

ClaudeSDKError

すべてのSDKエラーの基本例外クラス。

class ClaudeSDKError(Exception):
    """Base error for Claude SDK."""

​

CLINotFoundError

Claude Code CLIがインストールされていないか見つからない場合に発生します。

class CLINotFoundError(CLIConnectionError):
    def __init__(self, message: str = "Claude Code not found", cli_path: str | None = None):
        """
        Args:
            message: Error message (default: "Claude Code not found")
            cli_path: Optional path to the CLI that was not found
        """

​

CLIConnectionError

Claude Codeへの接続に失敗した場合に発生します。

class CLIConnectionError(ClaudeSDKError):
    """Failed to connect to Claude Code."""

​

ProcessError

Claude Codeプロセスが失敗した場合に発生します。

class ProcessError(ClaudeSDKError):
    def __init__(self, message: str, exit_code: int | None = None, stderr: str | None = None):
        self.exit_code = exit_code
        self.stderr = stderr

​

CLIJSONDecodeError

JSONパースに失敗した場合に発生します。

class CLIJSONDecodeError(ClaudeSDKError):
    def __init__(self, line: str, original_error: Exception):
        """
        Args:
            line: The line that failed to parse
            original_error: The original JSON decode exception
        """
        self.line = line
        self.original_error = original_error

​

フック型

​

HookEvent

サポートされているフックイベント型。セットアップの制限により、Python SDKはSessionStart、SessionEnd、およびNotificationフックをサポートしていません。

HookEvent = Literal[
    "PreToolUse",      # Called before tool execution
    "PostToolUse",     # Called after tool execution
    "UserPromptSubmit", # Called when user submits a prompt
    "Stop",            # Called when stopping execution
    "SubagentStop",    # Called when a subagent stops
    "PreCompact"       # Called before message compaction
]

​

HookCallback

フックコールバック関数の型定義。

HookCallback = Callable[
    [dict[str, Any], str | None, HookContext],
    Awaitable[dict[str, Any]]
]

パラメータ：

• input_data: フック固有の入力データ（フックドキュメント を参照）
• tool_use_id: オプションのツール使用識別子（ツール関連フック用）
• context: 追加情報を含むフックコンテキスト

以下を含む可能性のある辞書を返します：

• decision: アクションをブロックするには "block"
• systemMessage: トランスクリプトに追加するシステムメッセージ
• hookSpecificOutput: フック固有の出力データ

​

HookContext

フックコールバックに渡されるコンテキスト情報。

@dataclass
class HookContext:
    signal: Any | None = None  # Future: abort signal support

​

HookMatcher

特定のイベントまたはツールにフックをマッチングするための設定。

@dataclass
class HookMatcher:
    matcher: str | None = None        # Tool name or pattern to match (e.g., "Bash", "Write|Edit")
    hooks: list[HookCallback] = field(default_factory=list)  # List of callbacks to execute

​

フック使用例

from claude_agent_sdk import query, ClaudeAgentOptions, HookMatcher, HookContext
from typing import Any

async def validate_bash_command(
    input_data: dict[str, Any],
    tool_use_id: str | None,
    context: HookContext
) -> dict[str, Any]:
    """Validate and potentially block dangerous bash commands."""
    if input_data['tool_name'] == 'Bash':
        command = input_data['tool_input'].get('command', '')
        if 'rm -rf /' in command:
            return {
                'hookSpecificOutput': {
                    'hookEventName': 'PreToolUse',
                    'permissionDecision': 'deny',
                    'permissionDecisionReason': 'Dangerous command blocked'
                }
            }
    return {}

async def log_tool_use(
    input_data: dict[str, Any],
    tool_use_id: str | None,
    context: HookContext
) -> dict[str, Any]:
    """Log all tool usage for auditing."""
    print(f"Tool used: {input_data.get('tool_name')}")
    return {}

options = ClaudeAgentOptions(
    hooks={
        'PreToolUse': [
            HookMatcher(matcher='Bash', hooks=[validate_bash_command]),
            HookMatcher(hooks=[log_tool_use])  # Applies to all tools
        ],
        'PostToolUse': [
            HookMatcher(hooks=[log_tool_use])
        ]
    }
)

async for message in query(
    prompt="Analyze this codebase",
    options=options
):
    print(message)

​

ツール入出力型

すべての組み込みClaude Codeツールの入出力スキーマのドキュメント。Python SDKはこれらを型としてエクスポートしませんが、メッセージ内のツール入出力の構造を表します。

​

Task

ツール名: Task

入力:

{
    "description": str,      # A short (3-5 word) description of the task
    "prompt": str,           # The task for the agent to perform
    "subagent_type": str     # The type of specialized agent to use
}

出力:

{
    "result": str,                    # Final result from the subagent
    "usage": dict | None,             # Token usage statistics
    "total_cost_usd": float | None,  # Total cost in USD
    "duration_ms": int | None         # Execution duration in milliseconds
}

​

Bash

ツール名: Bash

入力:

{
    "command": str,                  # The command to execute
    "timeout": int | None,           # Optional timeout in milliseconds (max 600000)
    "description": str | None,       # Clear, concise description (5-10 words)
    "run_in_background": bool | None # Set to true to run in background
}

出力:

{
    "output": str,              # Combined stdout and stderr output
    "exitCode": int,            # Exit code of the command
    "killed": bool | None,      # Whether command was killed due to timeout
    "shellId": str | None       # Shell ID for background processes
}

​

Edit

ツール名: Edit

入力:

{
    "file_path": str,           # The absolute path to the file to modify
    "old_string": str,          # The text to replace
    "new_string": str,          # The text to replace it with
    "replace_all": bool | None  # Replace all occurrences (default False)
}

出力:

{
    "message": str,      # Confirmation message
    "replacements": int, # Number of replacements made
    "file_path": str     # File path that was edited
}

​

Read

ツール名: Read

入力:

{
    "file_path": str,       # The absolute path to the file to read
    "offset": int | None,   # The line number to start reading from
    "limit": int | None     # The number of lines to read
}

出力（テキストファイル）:

{
    "content": str,         # File contents with line numbers
    "total_lines": int,     # Total number of lines in file
    "lines_returned": int   # Lines actually returned
}

出力（画像）:

{
    "image": str,       # Base64 encoded image data
    "mime_type": str,   # Image MIME type
    "file_size": int    # File size in bytes
}

​

Write

ツール名: Write

入力:

{
    "file_path": str,  # The absolute path to the file to write
    "content": str     # The content to write to the file
}

出力:

{
    "message": str,        # Success message
    "bytes_written": int,  # Number of bytes written
    "file_path": str       # File path that was written
}

​

Glob

ツール名: Glob

入力:

{
    "pattern": str,       # The glob pattern to match files against
    "path": str | None    # The directory to search in (defaults to cwd)
}

出力:

{
    "matches": list[str],  # Array of matching file paths
    "count": int,          # Number of matches found
    "search_path": str     # Search directory used
}

​

Grep

ツール名: Grep

入力:

{
    "pattern": str,                    # The regular expression pattern
    "path": str | None,                # File or directory to search in
    "glob": str | None,                # Glob pattern to filter files
    "type": str | None,                # File type to search
    "output_mode": str | None,         # "content", "files_with_matches", or "count"
    "-i": bool | None,                 # Case insensitive search
    "-n": bool | None,                 # Show line numbers
    "-B": int | None,                  # Lines to show before each match
    "-A": int | None,                  # Lines to show after each match
    "-C": int | None,                  # Lines to show before and after
    "head_limit": int | None,          # Limit output to first N lines/entries
    "multiline": bool | None           # Enable multiline mode
}

出力（contentモード）:

{
    "matches": [
        {
            "file": str,
            "line_number": int | None,
            "line": str,
            "before_context": list[str] | None,
            "after_context": list[str] | None
        }
    ],
    "total_matches": int
}

出力（files_with_matchesモード）:

{
    "files": list[str],  # Files containing matches
    "count": int         # Number of files with matches
}

​

NotebookEdit

ツール名: NotebookEdit

入力:

{
    "notebook_path": str,                     # Absolute path to the Jupyter notebook
    "cell_id": str | None,                    # The ID of the cell to edit
    "new_source": str,                        # The new source for the cell
    "cell_type": "code" | "markdown" | None,  # The type of the cell
    "edit_mode": "replace" | "insert" | "delete" | None  # Edit operation type
}

出力:

{
    "message": str, # Success message
    "edit_type": "replaced" | "inserted" | "deleted",  # Type of edit performed
    "cell_id": str | None,                       # Cell ID that was affected
    "total_cells": int                           # Total cells in notebook after edit
}

​

WebFetch

ツール名: WebFetch

入力:

{
    "url": str,     # The URL to fetch content from
    "prompt": str   # The prompt to run on the fetched content
}

出力:

{
    "response": str,           # AI model's response to the prompt
    "url": str,                # URL that was fetched
    "final_url": str | None,   # Final URL after redirects
    "status_code": int | None  # HTTP status code
}

​

WebSearch

ツール名: WebSearch

入力:

{
    "query": str,                        # The search query to use
    "allowed_domains": list[str] | None, # Only include results from these domains
    "blocked_domains": list[str] | None  # Never include results from these domains
}

出力:

{
    "results": [
        {
            "title": str,
            "url": str,
            "snippet": str,
            "metadata": dict | None
        }
    ],
    "total_results": int,
    "query": str
}

​

TodoWrite

ツール名: TodoWrite

入力:

{
    "todos": [
        {
            "content": str, # The task description
            "status": "pending" | "in_progress" | "completed",  # Task status
            "activeForm": str                            # Active form of the description
        }
    ]
}

出力:

{
    "message": str,  # Success message
    "stats": {
        "total": int,
        "pending": int,
        "in_progress": int,
        "completed": int
    }
}

​

BashOutput

ツール名: BashOutput

入力:

{
    "bash_id": str,       # The ID of the background shell
    "filter": str | None  # Optional regex to filter output lines
}

出力:

{
    "output": str, # New output since last check
    "status": "running" | "completed" | "failed",       # Current shell status
    "exitCode": int | None # Exit code when completed
}

​

KillBash

ツール名: KillBash

入力:

{
    "shell_id": str  # The ID of the background shell to kill
}

出力:

{
    "message": str,  # Success message
    "shell_id": str  # ID of the killed shell
}

​

ExitPlanMode

ツール名: ExitPlanMode

入力:

{
    "plan": str  # The plan to run by the user for approval
}

出力:

{
    "message": str,          # Confirmation message
    "approved": bool | None  # Whether user approved the plan
}

​

ListMcpResources

ツール名: ListMcpResources

入力:

{
    "server": str | None  # Optional server name to filter resources by
}

出力:

{
    "resources": [
        {
            "uri": str,
            "name": str,
            "description": str | None,
            "mimeType": str | None,
            "server": str
        }
    ],
    "total": int
}

​

ReadMcpResource

ツール名: ReadMcpResource

入力:

{
    "server": str,  # The MCP server name
    "uri": str      # The resource URI to read
}

出力:

{
    "contents": [
        {
            "uri": str,
            "mimeType": str | None,
            "text": str | None,
            "blob": str | None
        }
    ],
    "server": str
}

​

ClaudeSDKClientを使用した高度な機能

​

継続的な会話インターフェースの構築

from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions, AssistantMessage, TextBlock
import asyncio

class ConversationSession:
    """Maintains a single conversation session with Claude."""

    def __init__(self, options: ClaudeAgentOptions = None):
        self.client = ClaudeSDKClient(options)
        self.turn_count = 0

    async def start(self):
        await self.client.connect()
        print("Starting conversation session. Claude will remember context.")
        print("Commands: 'exit' to quit, 'interrupt' to stop current task, 'new' for new session")

        while True:
            user_input = input(f"\n[Turn {self.turn_count + 1}] You: ")

            if user_input.lower() == 'exit':
                break
            elif user_input.lower() == 'interrupt':
                await self.client.interrupt()
                print("Task interrupted!")
                continue
            elif user_input.lower() == 'new':
                # Disconnect and reconnect for a fresh session
                await self.client.disconnect()
                await self.client.connect()
                self.turn_count = 0
                print("Started new conversation session (previous context cleared)")
                continue

            # Send message - Claude remembers all previous messages in this session
            await self.client.query(user_input)
            self.turn_count += 1

            # Process response
            print(f"[Turn {self.turn_count}] Claude: ", end="")
            async for message in self.client.receive_response():
                if isinstance(message, AssistantMessage):
                    for block in message.content:
                        if isinstance(block, TextBlock):
                            print(block.text, end="")
            print()  # New line after response

        await self.client.disconnect()
        print(f"Conversation ended after {self.turn_count} turns.")

async def main():
    options = ClaudeAgentOptions(
        allowed_tools=["Read", "Write", "Bash"],
        permission_mode="acceptEdits"
    )
    session = ConversationSession(options)
    await session.start()

# Example conversation:
# Turn 1 - You: "Create a file called hello.py"
# Turn 1 - Claude: "I'll create a hello.py file for you..."
# Turn 2 - You: "What's in that file?"
# Turn 2 - Claude: "The hello.py file I just created contains..." (remembers!)
# Turn 3 - You: "Add a main function to it"
# Turn 3 - Claude: "I'll add a main function to hello.py..." (knows which file!)

asyncio.run(main())

​

動作修正のためのフックの使用

from claude_agent_sdk import (
    ClaudeSDKClient,
    ClaudeAgentOptions,
    HookMatcher,
    HookContext
)
import asyncio
from typing import Any

async def pre_tool_logger(
    input_data: dict[str, Any],
    tool_use_id: str | None,
    context: HookContext
) -> dict[str, Any]:
    """Log all tool usage before execution."""
    tool_name = input_data.get('tool_name', 'unknown')
    print(f"[PRE-TOOL] About to use: {tool_name}")

    # You can modify or block the tool execution here
    if tool_name == "Bash" and "rm -rf" in str(input_data.get('tool_input', {})):
        return {
            'hookSpecificOutput': {
                'hookEventName': 'PreToolUse',
                'permissionDecision': 'deny',
                'permissionDecisionReason': 'Dangerous command blocked'
            }
        }
    return {}

async def post_tool_logger(
    input_data: dict[str, Any],
    tool_use_id: str | None,
    context: HookContext
) -> dict[str, Any]:
    """Log results after tool execution."""
    tool_name = input_data.get('tool_name', 'unknown')
    print(f"[POST-TOOL] Completed: {tool_name}")
    return {}

async def user_prompt_modifier(
    input_data: dict[str, Any],
    tool_use_id: str | None,
    context: HookContext
) -> dict[str, Any]:
    """Add context to user prompts."""
    original_prompt = input_data.get('prompt', '')

    # Add timestamp to all prompts
    from datetime import datetime
    timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")

    return {
        'hookSpecificOutput': {
            'hookEventName': 'UserPromptSubmit',
            'updatedPrompt': f"[{timestamp}] {original_prompt}"
        }
    }

async def main():
    options = ClaudeAgentOptions(
        hooks={
            'PreToolUse': [
                HookMatcher(hooks=[pre_tool_logger]),
                HookMatcher(matcher='Bash', hooks=[pre_tool_logger])
            ],
            'PostToolUse': [
                HookMatcher(hooks=[post_tool_logger])
            ],
            'UserPromptSubmit': [
                HookMatcher(hooks=[user_prompt_modifier])
            ]
        },
        allowed_tools=["Read", "Write", "Bash"]
    )

    async with ClaudeSDKClient(options=options) as client:
        await client.query("List files in current directory")

        async for message in client.receive_response():
            # Hooks will automatically log tool usage
            pass

asyncio.run(main())

​

リアルタイム進捗監視

from claude_agent_sdk import (
    ClaudeSDKClient,
    ClaudeAgentOptions,
    AssistantMessage,
    ToolUseBlock,
    ToolResultBlock,
    TextBlock
)
import asyncio

async def monitor_progress():
    options = ClaudeAgentOptions(
        allowed_tools=["Write", "Bash"],
        permission_mode="acceptEdits"
    )

    async with ClaudeSDKClient(options=options) as client:
        await client.query(
            "Create 5 Python files with different sorting algorithms"
        )

        # Monitor progress in real-time
        files_created = []
        async for message in client.receive_messages():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, ToolUseBlock):
                        if block.name == "Write":
                            file_path = block.input.get("file_path", "")
                            print(f"🔨 Creating: {file_path}")
                    elif isinstance(block, ToolResultBlock):
                        print(f"✅ Completed tool execution")
                    elif isinstance(block, TextBlock):
                        print(f"💭 Claude says: {block.text[:100]}...")

            # Check if we've received the final result
            if hasattr(message, 'subtype') and message.subtype in ['success', 'error']:
                print(f"\n🎯 Task completed!")
                break

asyncio.run(monitor_progress())

​

使用例

​

基本的なファイル操作（queryを使用）

from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, ToolUseBlock
import asyncio

async def create_project():
    options = ClaudeAgentOptions(
        allowed_tools=["Read", "Write", "Bash"],
        permission_mode='acceptEdits',
        cwd="/home/user/project"
    )

    async for message in query(
        prompt="Create a Python project structure with setup.py",
        options=options
    ):
        if isinstance(message, AssistantMessage):
            for block in message.content:
                if isinstance(block, ToolUseBlock):
                    print(f"Using tool: {block.name}")

asyncio.run(create_project())

​

エラーハンドリング

from claude_agent_sdk import (
    query,
    CLINotFoundError,
    ProcessError,
    CLIJSONDecodeError
)

try:
    async for message in query(prompt="Hello"):
        print(message)
except CLINotFoundError:
    print("Please install Claude Code: npm install -g @anthropic-ai/claude-code")
except ProcessError as e:
    print(f"Process failed with exit code: {e.exit_code}")
except CLIJSONDecodeError as e:
    print(f"Failed to parse response: {e}")

​

クライアントでのストリーミングモード

from claude_agent_sdk import ClaudeSDKClient
import asyncio

async def interactive_session():
    async with ClaudeSDKClient() as client:
        # Send initial message
        await client.query("What's the weather like?")

        # Process responses
        async for msg in client.receive_response():
            print(msg)

        # Send follow-up
        await client.query("Tell me more about that")

        # Process follow-up response
        async for msg in client.receive_response():
            print(msg)

asyncio.run(interactive_session())

​

ClaudeSDKClientでのカスタムツールの使用

from claude_agent_sdk import (
    ClaudeSDKClient,
    ClaudeAgentOptions,
    tool,
    create_sdk_mcp_server,
    AssistantMessage,
    TextBlock
)
import asyncio
from typing import Any

# Define custom tools with @tool decorator
@tool("calculate", "Perform mathematical calculations", {"expression": str})
async def calculate(args: dict[str, Any]) -> dict[str, Any]:
    try:
        result = eval(args["expression"], {"__builtins__": {}})
        return {
            "content": [{
                "type": "text",
                "text": f"Result: {result}"
            }]
        }
    except Exception as e:
        return {
            "content": [{
                "type": "text",
                "text": f"Error: {str(e)}"
            }],
            "is_error": True
        }

@tool("get_time", "Get current time", {})
async def get_time(args: dict[str, Any]) -> dict[str, Any]:
    from datetime import datetime
    current_time = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
    return {
        "content": [{
            "type": "text",
            "text": f"Current time: {current_time}"
        }]
    }

async def main():
    # Create SDK MCP server with custom tools
    my_server = create_sdk_mcp_server(
        name="utilities",
        version="1.0.0",
        tools=[calculate, get_time]
    )

    # Configure options with the server
    options = ClaudeAgentOptions(
        mcp_servers={"utils": my_server},
        allowed_tools=[
            "mcp__utils__calculate",
            "mcp__utils__get_time"
        ]
    )

    # Use ClaudeSDKClient for interactive tool usage
    async with ClaudeSDKClient(options=options) as client:
        await client.query("What's 123 * 456?")

        # Process calculation response
        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(f"Calculation: {block.text}")

        # Follow up with time query
        await client.query("What time is it now?")

        async for message in client.receive_response():
            if isinstance(message, AssistantMessage):
                for block in message.content:
                    if isinstance(block, TextBlock):
                        print(f"Time: {block.text}")

asyncio.run(main())

​

関連項目

• Python SDKガイド - チュートリアルと例
• SDKの概要 - 一般的なSDKの概念
• TypeScript SDKリファレンス - TypeScript SDKドキュメント
• CLIリファレンス - コマンドラインインターフェース
• 一般的なワークフロー - ステップバイステップガイド