Claude Agent SDK for Python
Python SDK for Claude Agent. See the Claude Agent SDK documentation for more information.
Installation
pip install claude-agent-sdk
Prerequisites:
- Python 3.10+
Note: The Claude Code CLI is automatically bundled with the package - no separate installation required! The SDK will use the bundled CLI by default. If you prefer to use a system-wide installation or a specific version, you can:
- Install Claude Code separately:
curl -fsSL https://claude.ai/install.sh | bash - Specify a custom path:
ClaudeAgentOptions(cli_path="/path/to/claude")
Quick Start
import anyio
from claude_agent_sdk import query
async def main():
async for message in query(prompt="What is 2 + 2?"):
print(message)
anyio.run(main)
Basic Usage: query()
query() is an async function for querying Claude Code. It returns an AsyncIterator of response messages. See src/claude_agent_sdk/query.py.
from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, TextBlock
# Simple query
async for message in query(prompt="Hello Claude"):
if isinstance(message, AssistantMessage):
for block in message.content:
if isinstance(block, TextBlock):
print(block.text)
# With options
options = ClaudeAgentOptions(
system_prompt="You are a helpful assistant",
max_turns=1
)
async for message in query(prompt="Tell me a joke", options=options):
print(message)
Using Tools
By default, Claude has access to the full Claude Code toolset (Read, Write, Edit, Bash, and others). allowed_tools is a permission allowlist: listed tools are auto-approved, and unlisted tools fall through to permission_mode and can_use_tool for a decision. It does not remove tools from Claude's toolset. To block specific tools, use disallowed_tools. See the permissions guide for the full evaluation order.
options = ClaudeAgentOptions(
allowed_tools=["Read", "Write", "Bash"], # auto-approve these tools
permission_mode='acceptEdits' # auto-accept file edits
)
async for message in query(
prompt="Create a hello.py file",
options=options
):
# Process tool use and results
pass
Working Directory
from pathlib import Path
options = ClaudeAgentOptions(
cwd="/path/to/project" # or Path("/path/to/project")
)
System Prompt
By default, Claude Code builds the system prompt on a session's first request, records it, and reuses it on every later request, including after you resume the session. A changed custom prompt, or changed append text on the claude_code preset, then has no effect until the session is compacted or you start a new session. To rebuild the prompt on every request instead, for example while you iterate on its wording, set snapshot to False in the {"type": "preset", ...} or {"type": "custom", ...} dict:
options = ClaudeAgentOptions(
system_prompt={"type": "custom", "prompt": "You are a release bot.", "snapshot": False}
)
Requires Claude Code CLI 2.1.257 or later. Before 2.1.265, a session with an append or custom prompt recorded it only when snapshot was True. See Modifying system prompts for details.
ClaudeSDKClient
ClaudeSDKClient supports bidirectional, interactive conversations with Claude
Code. See src/claude_agent_sdk/client.py.
Unlike query(), ClaudeSDKClient additionally enables custom tools and hooks, both of which can be defined as Python functions.
Custom Tools (as In-Process SDK MCP Servers)
A custom tool is a Python function that you can offer to Claude, for Claude to invoke as needed.
Custom tools are implemented in-process MCP servers that run directly within your Python application, eliminating the need for separate processes that regular MCP servers require.
For an end-to-end example, see MCP Calculator.
Creating a Simple Tool
from claude_agent_sdk import tool, create_sdk_mcp_server, ClaudeAgentOptions, ClaudeSDKClient
# Define a tool using the @tool decorator
@tool("greet", "Greet a user", {"name": str})
async def greet_user(args):
return {
"content": [
{"type": "text", "text": f"Hello, {args['name']}!"}
]
}
# Create an SDK MCP server
server = create_sdk_mcp_server(
name="my-tools",
version="1.0.0",
tools=[greet_user]
)
# Use it with Claude. allowed_tools pre-approves the tool so it runs
# without a permission prompt; it does not control tool availability.
options = ClaudeAgentOptions(
mcp_servers={"tools": server},
allowed_tools=["mcp__tools__greet"]
)
async with ClaudeSDKClient(options=options) as client:
await client.query("Greet Alice")
# Extract and print response
async for msg in client.receive_response():
print(msg)
Benefits Over External MCP Servers
- No subprocess management - Runs in the same process as your application
- Better performance - No IPC overhead for tool calls
- Simpler deployment - Single Python process instead of multiple
- Easier debugging - All code runs in the same process
- Type safety - Direct Python function calls with type hints
Migration from External Servers
# BEFORE: External MCP server (separate process)
options = ClaudeAgentOptions(
mcp_servers={
"calculator": {
"type": "stdio",
"command": "python",
"args": ["-m", "calculator_server"]
}
}
)
# AFTER: SDK MCP server (in-process)
from my_tools import add, subtract # Your tool functions
calculator = create_sdk_mcp_server(
name="calculator",
tools=[add, subtract]
)
options = ClaudeAgentOptions(
mcp_servers={"calculator": calculator}
)
Mixed Server Support
You can use both SDK and external MCP servers together:
options = ClaudeAgentOptions(
mcp_servers={
"internal": sdk_server, # In-process SDK server
"external": { # External subprocess server
"type": "stdio",
"command": "external-server"
}
}
)
Hooks
A hook is a Python function that the Claude Code application (not Claude) invokes at specific points of the Claude agent loop. Hooks can provide deterministic processing and automated feedback for Claude. Read more in Intercept and control agent behavior with hooks.
For more examples, see examples/hooks.py.
Example
from claude_agent_sdk import ClaudeAgentOptions, ClaudeSDKClient, HookMatcher
async def check_bash_command(input_data, tool_use_id, context):
tool_name = input_data["tool_name"]
tool_input = input_data["tool_input"]
if tool_name != "Bash":
return {}
command = tool_input.get("command", "")
block_patterns = ["foo.sh"]
for pattern in block_patterns:
if pattern in command:
return {
"hookSpecificOutput": {
"hookEventName": "PreToolUse",
"permissionDecision": "deny",
"permissionDecisionReason": f"Command contains invalid pattern: {pattern}",
}
}
return {}
options = ClaudeAgentOptions(
allowed_tools=["Bash"],
hooks={
"PreToolUse": [
HookMatcher(matcher="Bash", hooks=[check_bash_command]),
],
}
)
async with ClaudeSDKClient(options=options) as client:
# Test 1: Command with forbidden pattern (will be blocked)
await client.query("Run the bash command: ./foo.sh --help")
async for msg in client.receive_response():
print(msg)
print("\n" + "=" * 50 + "\n")
# Test 2: Safe command that should work
await client.query("Run the bash command: echo 'Hello from hooks example!'")
async for msg in client.receive_response():
print(msg)
Types
See src/claude_agent_sdk/types.py for complete type definitions:
ClaudeAgentOptions- Configuration optionsAssistantMessage,UserMessage,SystemMessage,ResultMessage- Message typesTextBlock,ToolUseBlock,ToolResultBlock- Content blocks
Error Handling
from claude_agent_sdk import (
ClaudeSDKError, # Base error
CLINotFoundError, # Claude Code not installed
CLIConnectionError, # Connection issues
ProcessError, # Process failed
ResultError, # Run ended with an error result (subclass of ProcessError)
CLIJSONDecodeError, # JSON parsing issues
)
try:
async for message in query(prompt="Hello"):
pass
except CLINotFoundError:
print("Please install Claude Code")
except ResultError as e:
# The CLI reported a terminal error result (also yielded as the final
# ResultMessage) and exited. Structured fields are on the exception.
print(f"Run failed: {e.subtype=} {e.terminal_reason=} {e.api_error_status=}")
print(e.result or e.errors)
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}")
See src/claude_agent_sdk/_errors.py for all error types.
Available Tools
See the Claude Code documentation for a complete list of available tools.
Examples
See examples/quick_start.py for a complete working example.
See examples/streaming_mode.py for comprehensive examples involving ClaudeSDKClient. You can even run interactive examples in IPython from examples/streaming_mode_ipython.py.
Migrating from Claude Code SDK
If you're upgrading from the Claude Code SDK (versions < 0.1.0), please see the CHANGELOG.md for details on breaking changes and new features, including:
ClaudeCodeOptions→ClaudeAgentOptionsrename- Merged system prompt configuration
- Settings isolation and explicit control
- New programmatic subagents and session forking features
Development
If you're contributing to this project, run the initial setup script to install git hooks:
./scripts/initial-setup.sh
This installs a pre-push hook that runs lint checks before pushing, matching the CI workflow. To skip the hook temporarily, use git push --no-verify.
Building Wheels Locally
To build wheels with the bundled Claude Code CLI:
# Install build dependencies
pip install build twine
# Build wheel with bundled CLI
python scripts/build_wheel.py
# Build with specific version
python scripts/build_wheel.py --version 0.1.4
# Build with specific CLI version
python scripts/build_wheel.py --cli-version 2.0.0
# Clean bundled CLI after building
python scripts/build_wheel.py --clean
# Skip CLI download (use existing)
python scripts/build_wheel.py --skip-download
The build script:
- Downloads Claude Code CLI for your platform
- Bundles it in the wheel
- Builds both wheel and source distribution
- Checks the package with twine
See python scripts/build_wheel.py --help for all options.
Release Workflow
The package is published to PyPI via the GitHub Actions workflow in .github/workflows/publish.yml. To create a new release:
-
Trigger the workflow manually from the Actions tab with two inputs:
version: The package version to publish (e.g.,0.1.5)claude_code_version: The Claude Code CLI version to bundle (e.g.,2.0.0orlatest)
-
The workflow will:
- Build platform-specific wheels for macOS, Linux, and Windows
- Bundle the specified Claude Code CLI version in each wheel
- Build a source distribution
- Publish all artifacts to PyPI
- Create a release branch with version updates
- Open a PR to main with:
- Updated
pyproject.tomlversion - Updated
src/claude_agent_sdk/_version.py - Updated
src/claude_agent_sdk/_cli_version.pywith bundled CLI version - Auto-generated
CHANGELOG.mdentry
- Updated
-
Review and merge the release PR to update main with the new version information
The workflow tracks both the package version and the bundled CLI version separately, allowing you to release a new package version with an updated CLI without code changes.
License and terms
Use of this SDK is governed by Anthropic's Commercial Terms of Service, including when you use it to power products and services that you make available to your own customers and end users, except to the extent a specific component or dependency is covered by a different license as indicated in that component's LICENSE file.
1 maintainer
Metadata
1 maintainer
Release files for claude-agent-sdk 0.2.165
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| claude_agent_sdk-0.2.165.tar.gz | 365.2 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| claude_agent_sdk-0.2.165-py3-none-win_amd64.whl | Python 3 | none | Windows x86-64 | Details |
| claude_agent_sdk-0.2.165-py3-none-manylinux_2_17_x86_64.whl | Python 3 | none | Linux glibc 2.17+ x86-64 | Details |
| claude_agent_sdk-0.2.165-py3-none-manylinux_2_17_aarch64.whl | Python 3 | none | Linux glibc 2.17+ ARM64 | Details |
| claude_agent_sdk-0.2.165-py3-none-macosx_11_0_x86_64.whl | Python 3 | none | macOS 11.0+ x86-64 | Details |
| claude_agent_sdk-0.2.165-py3-none-macosx_11_0_arm64.whl | Python 3 | none | macOS 11.0+ ARM64 | Details |
Total release size: 526.5 MB
Release files / claude_agent_sdk-0.2.165.tar.gz
| Download URL | claude_agent_sdk-0.2.165.tar.gz |
|---|---|
| Size | 365.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1bfa8e7a6bb36e82de9a12324c9bcfa6eebd4f96ee5890f0c656d50445240ff8
|
|
BLAKE2b-256 checksum How to use checksums |
7f4510f00a408b480926b5e340e3507562ede1e30d4ce5b73eea9ccc3468a9e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / claude_agent_sdk-0.2.165-py3-none-win_amd64.whl
| Download URL | claude_agent_sdk-0.2.165-py3-none-win_amd64.whl |
|---|---|
| Size | 110.4 MB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
cf41dc1b1019bc7321b695d621fc94e6d8982c095cfb7d433d5c293e356a2404
|
|
BLAKE2b-256 checksum How to use checksums |
7fd81685e8fc14bae5b9cbcfd6f4f6ca8b7ae8fd497a8bbf9c108978dd98620b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / claude_agent_sdk-0.2.165-py3-none-manylinux_2_17_x86_64.whl
| Download URL | claude_agent_sdk-0.2.165-py3-none-manylinux_2_17_x86_64.whl |
|---|---|
| Size | 107.8 MB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
9dbee4bfc69f0bb27ee455afdc19d78f958540a99217d2e28831fb9b7d496f08
|
|
BLAKE2b-256 checksum How to use checksums |
5781a0d3ff04ae7045218566b36d1c78729c3fc7550877e154697f263ac5122e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / claude_agent_sdk-0.2.165-py3-none-manylinux_2_17_aarch64.whl
| Download URL | claude_agent_sdk-0.2.165-py3-none-manylinux_2_17_aarch64.whl |
|---|---|
| Size | 107.4 MB |
| Tags | Linux glibc 2.17+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
46a47e1e1075a8f2b7976f6bd5aa06c5610cb322c47cdc5b728fb25d02691164
|
|
BLAKE2b-256 checksum How to use checksums |
404a93fe172811bcd7704c4c4776d5eed1bb1881ba440d86e0f8e5cbbec0dca9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / claude_agent_sdk-0.2.165-py3-none-macosx_11_0_x86_64.whl
| Download URL | claude_agent_sdk-0.2.165-py3-none-macosx_11_0_x86_64.whl |
|---|---|
| Size | 102.5 MB |
| Tags | Python 3 macOS 11.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
f4b5c6f536062e3af72357b1235f05ad4513230a32a3c639341a91a607d2df1e
|
|
BLAKE2b-256 checksum How to use checksums |
5c9d1eaa82f8dbafa63a3fb26aabc088be307c4977438269cc6cb10056a32e99
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / claude_agent_sdk-0.2.165-py3-none-macosx_11_0_arm64.whl
| Download URL | claude_agent_sdk-0.2.165-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 98.0 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
7f7017bb59eaf77b9a7c7ce3b9ed2c8a397b8201c8630f011bb1b955290f06e4
|
|
BLAKE2b-256 checksum How to use checksums |
e4a7a7226ae5e7fa3f225d99a0acf12ee354c4af9c953661f66bbcd424e48853
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
