# `ClaudeAgentSDK`
[🔗](https://github.com/nshkrdotcom/claude_agent_sdk/blob/v0.9.2/lib/claude_agent_sdk.ex#L1)

An Elixir SDK for Claude Code.

This module provides a simple interface for interacting with Claude Code programmatically.

## Basic Usage

    # Simple query
    for message <- ClaudeAgentSDK.query("Write a hello world function") do
      IO.inspect(message)
    end

    # With options
    opts = %ClaudeAgentSDK.Options{
      max_turns: 3,
      output_format: :json,
      system_prompt: "You are a helpful assistant"
    }
    
    for message <- ClaudeAgentSDK.query("Build a REST API", opts) do
      IO.inspect(message)
    end

## Authentication

This SDK uses the already-authenticated Claude CLI. You must authenticate manually first:

    # In your terminal:
    claude login

The SDK will use the stored authentication from your interactive Claude session.

# `continue`
[🔗](https://github.com/nshkrdotcom/claude_agent_sdk/blob/v0.9.2/lib/claude_agent_sdk.ex#L86)

```elixir
@spec continue(String.t() | nil, ClaudeAgentSDK.Options.t() | nil) ::
  Enumerable.t(ClaudeAgentSDK.Message.t())
```

Continues the most recent conversation.

## Parameters

  * `prompt` - Optional new prompt to add to the conversation
  * `options` - Optional `ClaudeAgentSDK.Options` struct with configuration

## Examples

    # Continue without new prompt
    ClaudeAgentSDK.continue()
    |> Enum.to_list()

    # Continue with new prompt
    ClaudeAgentSDK.continue("Now add error handling")
    |> Enum.to_list()

# `create_sdk_mcp_server`
[🔗](https://github.com/nshkrdotcom/claude_agent_sdk/blob/v0.9.2/lib/claude_agent_sdk.ex#L200)

```elixir
@spec create_sdk_mcp_server(keyword()) :: %{
  type: :sdk,
  name: String.t(),
  version: String.t(),
  registry_pid: pid()
}
```

Creates an SDK-based MCP server for in-process tool execution.

Unlike external MCP servers that require separate processes, SDK servers
run directly within your application, providing:
- Better performance (no subprocess overhead)
- Simpler deployment (no external dependencies)
- Direct function calls to your tool implementations

## Parameters

- `opts` - Keyword list with:
  - `:name` - Server name (string, required)
  - `:version` - Server version (string, required)
  - `:tools` - List of tool modules (list of atoms, required)

## Returns

A map representing the SDK MCP server with:
- `:type` - Always `:sdk`
- `:name` - Server name
- `:version` - Server version (defaults to "1.0.0")
- `:registry_pid` - PID of the tool registry GenServer

## Examples

    defmodule MyTools do
      use ClaudeAgentSDK.Tool

      deftool :add, "Add two numbers", %{
        type: "object",
        properties: %{a: %{type: "number"}, b: %{type: "number"}},
        required: ["a", "b"]
      } do
        def execute(%{"a" => a, "b" => b}) do
          {:ok, %{"content" => [%{"type" => "text", "text" => "#{a + b}"}]}}
        end
      end
    end

    # Create server
    server = ClaudeAgentSDK.create_sdk_mcp_server(
      name: "calculator",
      version: "1.0.0",
      tools: [MyTools.Add]
    )

    # Use in options
    options = %ClaudeAgentSDK.Options{
      mcp_servers: %{"calc" => server},
      allowed_tools: ["mcp__calc__add"]
    }

    ClaudeAgentSDK.query("Calculate 15 + 27", options)

# `list_sessions`
[🔗](https://github.com/nshkrdotcom/claude_agent_sdk/blob/v0.9.2/lib/claude_agent_sdk.ex#L119)

```elixir
@spec list_sessions(keyword()) ::
  {:ok, [ClaudeAgentSDK.SessionStore.session_metadata()]} | {:error, term()}
```

Lists saved Claude sessions from the SessionStore.

Starts the SessionStore automatically when needed.

# `query`
[🔗](https://github.com/nshkrdotcom/claude_agent_sdk/blob/v0.9.2/lib/claude_agent_sdk.ex#L62)

```elixir
@spec query(
  String.t() | Enumerable.t(),
  ClaudeAgentSDK.Options.t() | nil,
  term() | nil
) ::
  Enumerable.t(ClaudeAgentSDK.Message.t())
```

Runs a query against Claude Code and returns a stream of messages.

## Parameters

  * `prompt` - The prompt to send to Claude
  * `options` - Optional `ClaudeAgentSDK.Options` struct with configuration

## Returns

Returns a `Stream` that yields `ClaudeAgentSDK.Message` structs.

## Examples

    # Simple query
    ClaudeAgentSDK.query("Write a function to calculate Fibonacci numbers")
    |> Enum.to_list()

    # With options
    opts = %ClaudeAgentSDK.Options{max_turns: 5}
    ClaudeAgentSDK.query("Build a web server", opts)
    |> Enum.to_list()

# `resume`
[🔗](https://github.com/nshkrdotcom/claude_agent_sdk/blob/v0.9.2/lib/claude_agent_sdk.ex#L107)

```elixir
@spec resume(String.t(), String.t() | nil, ClaudeAgentSDK.Options.t() | nil) ::
  Enumerable.t(ClaudeAgentSDK.Message.t())
```

Resumes a specific conversation by session ID.

## Parameters

  * `session_id` - The session ID to resume
  * `prompt` - Optional new prompt to add to the conversation
  * `options` - Optional `ClaudeAgentSDK.Options` struct with configuration

## Examples

    ClaudeAgentSDK.resume("550e8400-e29b-41d4-a716-446655440000", "Add tests")
    |> Enum.to_list()

---

*Consult [api-reference.md](api-reference.md) for complete listing*