Claude Agent SDK for Rust

https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/
Admin
A Rust SDK for interacting with Claude Code CLI that enables programmatic access to Claude's...
Tokens:110,698
Snippets:827
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /get_server_info

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Retrieves server initialization information.

```APIDOC
## GET /get_server_info

### Description
Returns initialization information from the Claude Code server including available commands, output styles, and server capabilities.

### Response
#### Success Response (200)
- **info** (Value) - Dictionary with server info, or None if not connected.
```

--------------------------------

### Create ClaudeClient with Default Options

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Instantiates a new ClaudeClient using default configuration options. This is a simple way to get started.

```rust
use claude_agent_sdk_rs::{ClaudeClient, ClaudeAgentOptions};

let client = ClaudeClient::new(ClaudeAgentOptions::default());
```

--------------------------------

### Example Usage of Hooks

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/struct.Hooks.html

Demonstrates how to instantiate and configure hooks using the `Hooks` builder.

```APIDOC
## Example Usage of Hooks

### Description

This example shows how to create a `Hooks` builder, add different types of hooks, including hooks with specific matchers, and prepare them for use with `ClaudeAgentOptions`.

### Code Example

```rust
use claude_agent_sdk_rs::{Hooks, HookInput, HookContext, HookJsonOutput};

async fn my_hook(input: HookInput, tool_use_id: Option<String>, context: HookContext) -> HookJsonOutput {
    // Hook logic here
    HookJsonOutput::Sync(Default::default())
}

async fn main() {
    let mut hooks = Hooks::new();

    // Add a pre-tool-use hook that matches all tools
    hooks.add_pre_tool_use(my_hook);

    // Add a pre-tool-use hook that only matches the "Bash" tool
    hooks.add_pre_tool_use_with_matcher("Bash", my_hook);

    // Add a post-tool-use hook
    hooks.add_post_tool_use(my_hook);

    // Add a post-tool-use hook with a matcher
    hooks.add_post_tool_use_with_matcher("Write", my_hook);

    // Add other types of hooks
    hooks.add_user_prompt_submit(my_hook);
    hooks.add_stop(my_hook);
    hooks.add_subagent_stop(my_hook);
    hooks.add_pre_compact(my_hook);

    // Build the hooks into the format required for ClaudeAgentOptions
    let hooks_map = hooks.build();

    // Now `hooks_map` can be used to configure ClaudeAgentOptions
    // let options = ClaudeAgentOptions { hooks: hooks_map, ..Default::default() };
}
```

### Explanation

1.  **`use claude_agent_sdk_rs::{Hooks, HookInput, HookContext, HookJsonOutput};`**: Imports necessary types from the SDK.
2.  **`async fn my_hook(...)`**: Defines a sample asynchronous hook function. It takes `HookInput`, an optional `tool_use_id`, and `HookContext`, and returns a `HookJsonOutput`.
3.  **`let mut hooks = Hooks::new();`**: Initializes a new `Hooks` builder.
4.  **`hooks.add_pre_tool_use(my_hook);`**: Registers `my_hook` to be called before any tool execution.
5.  **`hooks.add_pre_tool_use_with_matcher("Bash", my_hook);`**: Registers `my_hook` to be called before the execution of tools specifically named "Bash".
6.  Similar calls are made for `add_post_tool_use`, `add_user_prompt_submit`, `add_stop`, `add_subagent_stop`, and `add_pre_compact`.
7.  **`let hooks_map = hooks.build();`**: Finalizes the hook configuration and converts it into the required `HashMap` format.
```

--------------------------------

### Handle File Metadata Operations with `and_then`

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates using `and_then` with file path operations. This example shows how to get metadata and then the modified time, propagating errors if any step fails.

```rust
use std::{io::ErrorKind, path::Path};

// Note: on Windows "/" maps to "C:\"
let root_modified_time = Path::new("/").metadata().and_then(|md| md.modified());
assert!(root_modified_time.is_ok());

let should_fail = Path::new("/bad/path").metadata().and_then(|md| md.modified());
assert!(should_fail.is_err());
assert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
```

--------------------------------

### Initialize SdkPluginConfig

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/plugin/enum.SdkPluginConfig.html

Examples of creating a local plugin configuration using the enum variant or the helper method.

```rust
use claude_agent_sdk_rs::SdkPluginConfig;
use std::path::PathBuf;

// Load a local plugin
let plugin = SdkPluginConfig::Local {
    path: PathBuf::from("./my-plugin"),
};
```

```rust
use claude_agent_sdk_rs::SdkPluginConfig;
use std::path::PathBuf;

let plugin = SdkPluginConfig::Local {
    path: PathBuf::from("~/.claude/plugins/my-plugin"),
};
```

```rust
use claude_agent_sdk_rs::SdkPluginConfig;

let plugin = SdkPluginConfig::local("./my-plugin");
```

--------------------------------

### Example: Cloning Result<&i32, i32>

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates cloning a Result containing a reference to an i32.

```rust
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
```

--------------------------------

### Example: Copying Result<&i32, i32>

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates copying a Result containing a reference to an i32.

```rust
let val = 12;
let x: Result<&i32, i32> = Ok(&val);
assert_eq!(x, Ok(&12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
```

--------------------------------

### Start New Session with ClaudeClient

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Starts a new conversation session with a specified session ID and initial prompt. This is useful for creating distinct conversational contexts. To reset memory completely, configure the client with `fork_session(true)`.

```rust
// First conversation
client.query("Hello").await?;

// Start new conversation with different context
client.new_session("session-2", "Tell me about Rust").await?;
```

--------------------------------

### Example: Flattening Nested Results

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates flattening a nested Result structure.

```rust
let x: Result<Result<&'static str, u32>, u32> = Ok(Ok("hello"));
assert_eq!(Ok("hello"), x.flatten());

let x: Result<Result<&'static str, u32>, u32> = Ok(Err(6));
assert_eq!(Err(6), x.flatten());

let x: Result<Result<&'static str, u32>, u32> = Err(6);
assert_eq!(Err(6), x.flatten());

let x: Result<Result<Result<&'static str, u32>, u32>, u32> = Ok(Ok(Ok("hello")));
assert_eq!(Ok(Ok("hello")), x.flatten());
assert_eq!(Ok("hello"), x.flatten().flatten());
```

--------------------------------

### Example: Checking if Result is Ok

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates using is_ok() to check the status of a Result.

```rust
let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_ok(), true);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_ok(), false);
```

--------------------------------

### Get Server Initialization Info in Rust

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Retrieve server initialization information, including available commands and output styles. Returns `None` if the client is not connected.

```rust
client.get_server_info()
```

--------------------------------

### Example: Checking if Result is Ok and matches predicate

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates using is_ok_and() with a closure to check the value.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.is_ok_and(|x| x > 1), true);

let x: Result<u32, &str> = Ok(0);
assert_eq!(x.is_ok_and(|x| x > 1), false);

let x: Result<u32, &str> = Err("hey");
assert_eq!(x.is_ok_and(|x| x > 1), false);

let x: Result<String, &str> = Ok("ownership".to_string());
assert_eq!(x.as_ref().is_ok_and(|x| x.len() > 1), true);
println!("still alive {:?}", x);
```

--------------------------------

### Create EfficiencyConfig with all features enabled

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/efficiency/struct.EfficiencyConfig.html

Instantiate a new EfficiencyConfig with all efficiency-related features activated. This is a convenient starting point for configurations where all options should be on by default.

```rust
pub fn enabled() -> Self
```

--------------------------------

### GET /version

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/version/constant.SDK_VERSION.html

Retrieves the current version of the Claude Agent SDK for Rust.

```APIDOC
## GET /version

### Description
Returns the current version string of the SDK.

### Method
GET

### Endpoint
/version

### Response
#### Success Response (200)
- **version** (string) - The current version of the SDK (e.g., "0.6.4").

#### Response Example
{
  "version": "0.6.4"
}
```

--------------------------------

### Example: Transposing Result<Option<i32>, SomeErr>

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Illustrates transposing a Result containing an Option of an i32.

```rust
#[derive(Debug, Eq, PartialEq)]
struct SomeErr;

let x: Result<Option<i32>, SomeErr> = Ok(Some(5));
let y: Option<Result<i32, SomeErr>> = Some(Ok(5));
assert_eq!(x.transpose(), y);
```

--------------------------------

### Example: Cloning Result<&mut i32, i32>

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates cloning a Result containing a mutable reference to an i32.

```rust
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let cloned = x.cloned();
assert_eq!(cloned, Ok(12));
```

--------------------------------

### Example: Copying Result<&mut i32, i32>

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates copying a Result containing a mutable reference to an i32.

```rust
let mut val = 12;
let x: Result<&mut i32, i32> = Ok(&mut val);
assert_eq!(x, Ok(&mut 12));
let copied = x.copied();
assert_eq!(copied, Ok(12));
```

--------------------------------

### Create Image Content Block

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/messages/enum.UserContentBlock.html

Example of creating an image content block using base64 encoded data.

```rust
let block = UserContentBlock::image_base64("image/png", "iVBORw0KGgo=")?;
```

--------------------------------

### POST /new_session

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Starts a new conversation session by switching to a different session ID and optionally providing an initial prompt.

```APIDOC
## POST /new_session

### Description
Starts a new session by switching to a different session ID. This is a convenience method that creates a new conversation context.

### Parameters
#### Request Body
- **session_id** (String) - Required - The new session ID to use.
- **prompt** (String) - Required - Initial message for the new session.

### Request Example
{
  "session_id": "session-2",
  "prompt": "Tell me about Rust"
}

### Response
#### Success Response (200)
- **Result** (Empty) - Returns success if the session is switched.
```

--------------------------------

### Get Server Info with ClaudeClient

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Retrieves server information, including available commands and output style. Ensure the client is connected before calling.

```rust
if let Some(info) = client.get_server_info() {
    println!("Commands available: {}", info.get("commands").map(|c| c.as_array().map(|a| a.len()).unwrap_or(0)).unwrap_or(0));
    println!("Output style: {:?}", info.get("output_style"));
}
```

--------------------------------

### Create and Configure Hooks

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/struct.Hooks.html

Demonstrates how to create a new Hooks builder and add pre-tool-use hooks, both for all tools and for a specific tool name like 'Bash'.

```rust
use claude_agent_sdk_rs::{Hooks, HookInput, HookContext, HookJsonOutput};

async fn my_hook(input: HookInput, tool_use_id: Option<String>, context: HookContext) -> HookJsonOutput {
    HookJsonOutput::Sync(Default::default())
}

let mut hooks = Hooks::new();
hooks.add_pre_tool_use(my_hook); // Matches all tools
hooks.add_pre_tool_use_with_matcher("Bash", my_hook); // Only Bash tool
```

--------------------------------

### Implementing MyTrait for Arc<UdpSocket>

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

This example shows how to implement a trait that requires `AsFd` on an `Arc<UdpSocket>`. This is useful for enabling traits that depend on `AsFd` to work with `Arc`-wrapped types.

```rust
use std::net::UdpSocket;
use std::sync::Arc;

trait MyTrait: AsFd {} // Assuming AsFd is defined elsewhere
impl MyTrait for Arc<UdpSocket> {}
impl MyTrait for Box<UdpSocket> {}
```

--------------------------------

### Initialize and Use ClaudeClient

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Demonstrates the basic workflow of creating a client, connecting, sending a query, receiving the response stream, and disconnecting.

```rust
use claude_agent_sdk_rs::{ClaudeClient, ClaudeAgentOptions};
use futures::StreamExt;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = ClaudeClient::new(ClaudeAgentOptions::default());

    // Connect to Claude
    client.connect().await?;

    // Send a query
    client.query("Hello Claude!").await?;

    // Receive response as a stream
    {
        let mut stream = client.receive_response();
        while let Some(message) = stream.next().await {
            println!("Received: {:?}", message?);
        }
    }

    // Disconnect
    client.disconnect().await?;
    Ok(())
}
```

--------------------------------

### Initialize ClaudeAgentOptions with EfficiencyConfig

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.ClaudeAgentOptions.html

Demonstrates how to use the builder pattern to enable efficiency configurations for the agent.

```rust
use claude_agent_sdk_rs::{ClaudeAgentOptions, EfficiencyConfig};

let options = ClaudeAgentOptions::builder()
    .efficiency(EfficiencyConfig::enabled())
    .build();
```

--------------------------------

### fn weak_count

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Gets the number of Weak pointers to this allocation.

```APIDOC
## fn weak_count

### Description
Gets the number of `Weak` pointers to this allocation.

### Parameters
#### Path Parameters
- **this** (&Arc<T, A>) - Required - The Arc instance to check.

### Response
- **usize** - The count of weak pointers.
```

--------------------------------

### GET /receive_response

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Returns a stream of messages until a ResultMessage is encountered.

```APIDOC
## GET /receive_response

### Description
Returns a stream that yields messages until it encounters a ResultMessage, signaling the completion of a Claude response turn.

### Response
#### Success Response (200)
- **stream** (Stream<Result<Message>>) - A stream of messages ending with a ResultMessage.
```

--------------------------------

### fn strong_count

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Gets the number of strong (Arc) pointers to this allocation.

```APIDOC
## fn strong_count

### Description
Gets the number of strong (`Arc`) pointers to this allocation.

### Parameters
#### Path Parameters
- **this** (&Arc<T, A>) - Required - The Arc instance to check.

### Response
- **usize** - The count of strong pointers.
```

--------------------------------

### SystemPromptPreset Struct

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SystemPromptPreset.html

Represents a system prompt preset with an optional appended text.

```APIDOC
## Struct SystemPromptPreset

### Description
System prompt preset

### Fields
- **type_** (String) - Required - Type field (always “preset”)
- **preset** (String) - Required - Preset name (e.g., “claude_code”)
- **append** (Option<String>) - Optional - Text to append to the preset

### Methods
#### pub fn new(preset: impl Into<String>) -> Self
Create a new preset with the given name

#### pub fn with_append(preset: impl Into<String>, append: impl Into<String>) -> Self
Create a preset with appended text
```

--------------------------------

### GET /receive_messages

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Returns a continuous stream of all messages from the Claude server.

```APIDOC
## GET /receive_messages

### Description
Returns a stream that yields all messages from Claude indefinitely until the stream is closed or an error occurs.

### Response
#### Success Response (200)
- **stream** (Stream<Result<Message>>) - A stream of messages.
```

--------------------------------

### Create an in-process MCP server

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/mcp/fn.create_sdk_mcp_server.html

Initializes an MCP server configuration with the specified name, version, and tools.

```rust
pub fn create_sdk_mcp_server(
    name: impl Into<String>,
    version: impl Into<String>,
    tools: Vec<SdkMcpTool>,
) -> McpSdkServerConfig
```

--------------------------------

### POST /build

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.ClaudeAgentOptionsBuilder.html

Finalizes the configuration process and constructs the ClaudeAgentOptions instance.

```APIDOC
## POST /build

### Description
Finalizes the builder configuration and creates a new instance of `ClaudeAgentOptions`.

### Method
POST

### Endpoint
/build

### Response
#### Success Response (200)
- **ClaudeAgentOptions** (object) - The resulting configuration object for the Claude agent.
```

--------------------------------

### Arc::weak_count

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Gets the number of Weak pointers pointing to the Arc's allocation.

```APIDOC
## GET /api/users/{id}/weak_count

### Description
Gets the number of `Weak` pointers to this allocation.

### Method
pub fn

### Endpoint
`Arc::weak_count(this: &Arc<T, A>) -> usize`

### Parameters
#### Path Parameters
- **this** (*&Arc<T, A>*) - Required - A reference to the Arc pointer.

### Request Body
This method does not take a request body.

### Response
#### Success Response (200)
- **usize** - The number of weak pointers.

#### Response Example
```json
{
  "example": 1
}
```

### Safety
Another thread can change the weak count at any time, potentially between calling this method and acting on the result.
```

--------------------------------

### build

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SandboxSettingsBuilder.html

Finalizes the builder configuration and returns a SandboxSettings instance.

```APIDOC
## build

### Description
Finalizes the builder and creates its `SandboxSettings` instance.

### Response
#### Success Response (200)
- **SandboxSettings** (object) - The resulting sandbox configuration instance.
```

--------------------------------

### Example: Checking if Result is Err

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Demonstrates using is_err() to check if a Result is an error.

```rust
let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_err(), false);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_err(), true);
```

--------------------------------

### Retrieve Plugin Path

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/plugin/enum.SdkPluginConfig.html

Demonstrates how to verify and retrieve the path from a local plugin configuration.

```rust
use claude_agent_sdk_rs::SdkPluginConfig;

let plugin = SdkPluginConfig::local("./my-plugin");
assert!(plugin.path().is_some());
```

--------------------------------

### Arc::strong_count

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Gets the number of strong (Arc) pointers pointing to the Arc's allocation.

```APIDOC
## GET /api/users/{id}/strong_count

### Description
Gets the number of strong (`Arc`) pointers to this allocation.

### Method
pub fn

### Endpoint
`Arc::strong_count(this: &Arc<T, A>) -> usize`

### Parameters
#### Path Parameters
- **this** (*&Arc<T, A>*) - Required - A reference to the Arc pointer.

### Request Body
This method does not take a request body.

### Response
#### Success Response (200)
- **usize** - The number of strong pointers.

#### Response Example
```json
{
  "example": 2
}
```

### Safety
Another thread can change the strong count at any time, potentially between calling this method and acting on the result.
```

--------------------------------

### ClaudeClient Initialization

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Methods for creating and configuring a new ClaudeClient instance.

```APIDOC
## ClaudeClient::new

### Description
Creates a new ClaudeClient instance with the provided configuration options.

### Parameters
#### Request Body
- **options** (ClaudeAgentOptions) - Required - Configuration options for the Claude client

### Request Example
let client = ClaudeClient::new(ClaudeAgentOptions::default());

## ClaudeClient::try_new

### Description
Creates a new ClaudeClient with early validation, checking for the existence of the working directory and the Claude CLI.

### Parameters
#### Request Body
- **options** (ClaudeAgentOptions) - Required - Configuration options for the Claude client

### Response
#### Success Response (200)
- **client** (ClaudeClient) - The initialized client instance

### Errors
- Returns an error if the working directory does not exist or the Claude CLI cannot be found.
```

--------------------------------

### Arc::get_mut

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Safely gets a mutable reference to the Arc's data if it's the sole owner.

```APIDOC
## GET /api/arc/get_mut

### Description
Returns a mutable reference into the given `Arc`, if there are no other `Arc` or `Weak` pointers to the same allocation. Returns `None` otherwise, because it is not safe to mutate a shared value.

### Method
GET

### Endpoint
/api/arc/get_mut

### Parameters
#### Query Parameters
- **this** (mut Arc<T, A>) - Required - A mutable reference to the Arc.

### Response
#### Success Response (200)
- **Option<&mut T>** (Option containing a mutable reference) - A mutable reference to the inner data if unique, otherwise `None`.

### Request Example
```json
{
  "this": "<arc_pointer>"
}
```

### Response Example
```json
{
  "result": "<mutable_reference_to_data>"
}
```
```

--------------------------------

### create_sdk_mcp_server Function

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/mcp/fn.create_sdk_mcp_server.html

Creates an in-process MCP server configuration.

```APIDOC
## create_sdk_mcp_server

### Description
Create an in-process MCP server.

### Signature
```rust
pub fn create_sdk_mcp_server(
    name: impl Into<String>,
    version: impl Into<String>,
    tools: Vec<SdkMcpTool>,
) -> McpSdkServerConfig
```

### Parameters
- **name** (impl Into<String>) - The name for the MCP server.
- **version** (impl Into<String>) - The version for the MCP server.
- **tools** (Vec<SdkMcpTool>) - A vector of SdkMcpTool to be used by the server.

### Returns
- **McpSdkServerConfig** - The configuration for the MCP server.
```

--------------------------------

### Unwrap Error Value

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `unwrap_err` to get the contained `Err` value. Panics if the value is an `Ok`.

```rust
let x: Result<u32, &str> = Ok(2);
x.unwrap_err(); // panics with `2`
```

```rust
let x: Result<u32, &str> = Err("emergency failure");
assert_eq!(x.unwrap_err(), "emergency failure");
```

--------------------------------

### Claude Agent SDK Configuration Options

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/index.html

Illustrates how to configure the Claude Agent SDK using `ClaudeAgentOptions`. This includes setting models, budget, token limits, turn limits, permission modes, and plugins.

```rust
use claude_agent_sdk_rs::{ClaudeAgentOptions, PermissionMode, SdkPluginConfig};

let options = ClaudeAgentOptions::builder()
    .model("claude-opus-4")
    .fallback_model("claude-sonnet-4")
    .max_budget_usd(10.0)
    .max_thinking_tokens(2000)
    .max_turns(10)
    .permission_mode(PermissionMode::Default)
    .plugins(vec![SdkPluginConfig::local("./my-plugin")])
    .build();
```

--------------------------------

### Unwrap Ok Value

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `unwrap` to get the contained `Ok` value. Panics if the value is an `Err`.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.unwrap(), 2);
```

--------------------------------

### Basic Arc Creation in Rust

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Demonstrates the fundamental creation of an `Arc` with an integer value.

```rust
use std::sync::Arc;

let five = Arc::new(5);

```

--------------------------------

### Implement CloneToUninit (Nightly)

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SandboxIgnoreViolations.html

Nightly-only experimental API for performing copy-assignment to uninitialized memory.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### Create EfficiencyConfig with metrics tracking enabled

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/efficiency/struct.EfficiencyConfig.html

Instantiate a new EfficiencyConfig with metrics tracking enabled. This allows for monitoring execution metrics and receiving specific warnings.

```rust
pub fn with_metrics() -> Self
```

--------------------------------

### UserPromptSubmitHookSpecificOutputBuilder Methods

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/struct.UserPromptSubmitHookSpecificOutputBuilder.html

Methods available for configuring and building the UserPromptSubmitHookSpecificOutput instance.

```APIDOC
## UserPromptSubmitHookSpecificOutputBuilder

### Description
Builder for creating instances of UserPromptSubmitHookSpecificOutput.

### Methods

#### additional_context(additional_context: impl Into<String>)
- **Description**: Sets the additional context to provide to Claude.
- **Parameters**:
  - **additional_context** (String) - Required - The context string to be passed.

#### build()
- **Description**: Finalizes the builder and returns a UserPromptSubmitHookSpecificOutput instance.
```

--------------------------------

### Get mutable reference to Arc

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Attempts to retrieve a mutable reference to the inner value if the Arc is uniquely owned.

```rust
use std::sync::Arc;

let mut x = Arc::new(3);
*Arc::get_mut(&mut x).unwrap() = 4;
assert_eq!(*x, 4);

let _y = Arc::clone(&x);
assert!(Arc::get_mut(&mut x).is_none());
```

--------------------------------

### ToolsPreset Implementations

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.ToolsPreset.html

Details on the implementations for the ToolsPreset struct, including traits like Clone, Debug, Deserialize, Serialize, and From.

```APIDOC
### Implementations for ToolsPreset

#### `impl Clone for ToolsPreset`
- `clone(&self) -> ToolsPreset`: Returns a duplicate of the value.
- `clone_from(&mut self, source: &Self)`: Performs copy-assignment from `source`.

#### `impl Debug for ToolsPreset`
- `fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

#### `impl<'de> Deserialize<'de> for ToolsPreset`
- `deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>`: Deserialize this value from the given Serde deserializer.

#### `impl From<ToolsPreset> for Tools`
- `from(preset: ToolsPreset) -> Self`: Converts to this type from the input type.

#### `impl Serialize for ToolsPreset`
- `serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>`: Serialize this value into the given Serde serializer.
```

--------------------------------

### Implement Error::cause (Deprecated)

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/struct.CliNotFoundError.html

Deprecated method for getting the cause of an error. Use Error::source instead.

```rust
fn cause(&self) -> Option<&dyn Error>
```

--------------------------------

### Attempting to Create Arc with Allocator API

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Shows how to use `Arc::try_new` with the `allocator_api` feature to construct an `Arc` and handle potential allocation errors.

```rust
#![feature(allocator_api)]
use std::sync::Arc;

let five = Arc::try_new(5)?;

```

--------------------------------

### Define a tool using the `tool` macro

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/macro.tool.html

Use this macro to define a tool with its name, description, schema, and a handler function. Ensure all arguments are provided correctly.

```rust
macro_rules! tool {
    ($name:expr, $desc:expr, $schema:expr, $handler:expr) => { ... };
}
```

--------------------------------

### Create EfficiencyConfig with only stop tips enabled

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/efficiency/struct.EfficiencyConfig.html

Instantiate a new EfficiencyConfig with only the stop tips feature enabled. This is useful if you want to inject efficiency tips in the Stop hook without other features.

```rust
pub fn stop_tips_only() -> Self
```

--------------------------------

### Clone SandboxSettingsBuilder in Rust

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SandboxSettingsBuilder.html

Returns a duplicate of the `SandboxSettingsBuilder`. This is useful for creating multiple configurations based on a common starting point.

```rust
fn clone(&self) -> Self
```

--------------------------------

### ClaudeAgentOptionsBuilder Configuration Methods

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.ClaudeAgentOptionsBuilder.html

Methods for configuring environment variables, CLI arguments, and buffer sizes for the agent builder.

```APIDOC
## env(env: HashMap<String, String>)

### Description
Sets the environment variables for the agent process.

### Parameters
#### Request Body
- **env** (HashMap<String, String>) - Required - A map of environment variable keys and values.

---

## extra_args(extra_args: HashMap<String, Option<String>>)

### Description
Sets additional CLI arguments to be passed to the agent process.

### Parameters
#### Request Body
- **extra_args** (HashMap<String, Option<String>>) - Required - A map of CLI argument keys and optional values.

---

## max_buffer_size(max_buffer_size: usize)

### Description
Sets the maximum buffer size for capturing subprocess output.

### Parameters
#### Request Body
- **max_buffer_size** (usize) - Required - The size limit in bytes for the output buffer.
```

--------------------------------

### Implement Error::description (Deprecated)

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/struct.CliNotFoundError.html

Deprecated method for getting an error description. Use the Display impl or to_string() instead.

```rust
fn description(&self) -> &str
```

--------------------------------

### Get Allocator from Arc (Nightly)

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Returns a reference to the underlying allocator used by the `Arc`. This is an associated function and requires the `allocator_api` feature.

```rust
use std::sync::Arc;
use std::alloc::System;

let x = Arc::new_in("hello".to_owned(), System);
let alloc = Arc::allocator(&x);
// alloc is a reference to System
```

--------------------------------

### Arc::get_mut_unchecked (Nightly)

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Unsafely gets a mutable reference to the Arc's data without checks. Requires nightly Rust.

```APIDOC
## GET /api/arc/get_mut_unchecked

### Description
Returns a mutable reference into the given `Arc`, without any check. This is a nightly-only experimental API.

### Method
GET

### Endpoint
/api/arc/get_mut_unchecked

### Parameters
#### Query Parameters
- **this** (mut Arc<T, A>) - Required - A mutable reference to the Arc.

### Response
#### Success Response (200)
- **&mut T** (mutable reference) - A mutable reference to the inner data.

### Request Example
```json
{
  "this": "<arc_pointer>"
}
```

### Response Example
```json
{
  "result": "<mutable_reference_to_data>"
}
```
```

--------------------------------

### Get metrics collector

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/efficiency/struct.EfficiencyConfig.html

Retrieve the metrics collector from an EfficiencyConfig if metrics tracking is enabled. Returns an Option containing an Arc<ExecutionMetrics>.

```rust
pub fn metrics(&self) -> Option<Arc<ExecutionMetrics>>
```

--------------------------------

### build()

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/struct.SyncHookJsonOutputBuilder.html

Finalizes the builder and creates a SyncHookJsonOutput instance.

```APIDOC
## build()

### Description
Finalise the builder and create its `SyncHookJsonOutput` instance.

### Response
- **SyncHookJsonOutput** - The resulting instance created by the builder.
```

--------------------------------

### Get Weak Reference Count

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Retrieves the number of `Weak` pointers pointing to the allocation. Be aware that the count can change concurrently in multithreaded scenarios.

```rust
use std::sync::Arc;

let five = Arc::new(5);
let _weak_five = Arc::downgrade(&five);

// This assertion is deterministic because we haven't shared
// the `Arc` or `Weak` between threads.
assert_eq!(1, Arc::weak_count(&five));

```

--------------------------------

### Provide Default Value with `unwrap_or`

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `unwrap_or` to get the `Ok` value or a provided default if `self` is `Err`. Arguments are eagerly evaluated.

```rust
let default = 2;
let x: Result<u32, &str> = Ok(9);
assert_eq!(x.unwrap_or(default), 9);

let x: Result<u32, &str> = Err("error");
assert_eq!(x.unwrap_or(default), default);
```

--------------------------------

### Create UserPromptSubmitHookSpecificOutput Builder

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/struct.UserPromptSubmitHookSpecificOutput.html

Provides a builder pattern for constructing UserPromptSubmitHookSpecificOutput instances. Use `.additional_context(...)` to set optional fields and `.build()` to finalize.

```rust
pub fn builder() -> UserPromptSubmitHookSpecificOutputBuilder<((),)>
```

--------------------------------

### Efficiency Configuration and Metrics

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/efficiency/index.html

Overview of the structs used for configuring efficiency tracking and capturing execution metrics.

```APIDOC
## Structs

### EfficiencyConfig
Configuration for efficiency-related features.

### ExecutionMetrics
Execution metrics collected during agent execution (e.g., tool calls, edits per file).

### MetricsSummary
Summary of execution metrics.
```

--------------------------------

### Implement build Method

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/struct.UserPromptSubmitHookSpecificOutputBuilder.html

Finalizes the builder and creates the UserPromptSubmitHookSpecificOutput instance. This method consumes the builder.

```rust
pub fn build(self) -> UserPromptSubmitHookSpecificOutput
```

--------------------------------

### Get References from Result

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `as_ref` to obtain a `Result<&T, &E>` from a `&Result<T, E>`. This allows inspecting the contents without consuming the original Result.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.as_ref(), Ok(&2));

let x: Result<u32, &str> = Err("Error");
assert_eq!(x.as_ref(), Err(&"Error"));
```

--------------------------------

### Attempting to Create Uninitialized Arc with Allocator API

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Demonstrates using `Arc::try_new_uninit` with the `allocator_api` feature for creating an uninitialized `Arc` and handling allocation errors.

```rust
#![feature(allocator_api)]

use std::sync::Arc;

let mut five = Arc::<u32>::try_new_uninit()?;

// Deferred initialization:
Arc::get_mut(&mut five).unwrap().write(5);

let five = unsafe { five.assume_init() };

assert_eq!(*five, 5);

```

--------------------------------

### Into Error Value (Never Panics)

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `into_err` to get the contained `Err` value. This method is guaranteed not to panic, serving as a compile-time safeguard against potential panics.

```rust
fn only_bad_news() -> Result<!, String> {
    Err("Oops, it failed".into())
}

let error: String = only_bad_news().into_err();
println!("{error}");
```

--------------------------------

### Into Ok Value (Never Panics)

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `into_ok` to get the contained `Ok` value. This method is guaranteed not to panic, making it a compile-time safeguard against potential panics.

```rust
fn only_good_news() -> Result<String, !> {
    Ok("this is fine".into())
}

let s: String = only_good_news().into_ok();
println!("{s}");
```

--------------------------------

### Create SandboxSettings Builder

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SandboxSettings.html

Provides a builder pattern for constructing SandboxSettings instances. Use the builder's methods to set optional fields like enabled, auto_allow_bash_if_sandboxed, excluded_commands, and others before calling build().

```rust
pub fn builder() -> SandboxSettingsBuilder<((), (), (), (), (), (), ())>
```

--------------------------------

### Unwrap or Default Value

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `unwrap_or_default` to get the contained `Ok` value or the default value for the type if it's an `Err`. Requires the type to implement `Default`.

```rust
let good_year_from_input = "1909";
let bad_year_from_input = "190blarg";
let good_year = good_year_from_input.parse().unwrap_or_default();
let bad_year = bad_year_from_input.parse().unwrap_or_default();

assert_eq!(1909, good_year);
assert_eq!(0, bad_year);
```

--------------------------------

### Creating Uninitialized Arc with new_uninit

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Demonstrates creating an `Arc` with uninitialized memory and deferring the initialization using `Arc::get_mut` and `write`.

```rust
use std::sync::Arc;

let mut five = Arc::<u32>::new_uninit();

// Deferred initialization:
Arc::get_mut(&mut five).unwrap().write(5);

let five = unsafe { five.assume_init() };

assert_eq!(*five, 5)

```

--------------------------------

### Get Mutable References from Result

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `as_mut` to obtain a `Result<&mut T, &mut E>` from a `&mut Result<T, E>`. This allows modifying the contents in place.

```rust
fn mutate(r: &mut Result<i32, i32>) {
    match r.as_mut() {
        Ok(v) => *v = 42,
        Err(e) => *e = 0,
    }
}

let mut x: Result<i32, i32> = Ok(2);
mutate(&mut x);
assert_eq!(x.unwrap(), 42);

let mut x: Result<i32, i32> = Err(13);
mutate(&mut x);
assert_eq!(x.unwrap_err(), 0);
```

--------------------------------

### pub fn new_uninit_in

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Constructs a new Arc with uninitialized contents in the provided allocator.

```APIDOC
## pub fn new_uninit_in(alloc: A) -> Arc<MaybeUninit<T>, A>

### Description
Constructs a new Arc with uninitialized contents in the provided allocator.

### Parameters
- **alloc** (A) - Required - The allocator to use.
```

--------------------------------

### Get Raw Pointer to Arc Data

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Provides a raw pointer to the data within an `Arc`. The pointer is valid as long as strong counts exist. The `Arc` is not consumed.

```rust
use std::sync::Arc;

let x = Arc::new("hello".to_owned());
let y = Arc::clone(&x);
let x_ptr = Arc::as_ptr(&x);
assert_eq!(x_ptr, Arc::as_ptr(&y));
assert_eq!(unsafe { &*x_ptr }, "hello");
```

--------------------------------

### SandboxNetworkConfigBuilder Methods

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SandboxNetworkConfigBuilder.html

Methods available for configuring the network settings of a sandbox environment.

```APIDOC
## SandboxNetworkConfigBuilder Methods

### allow_unix_sockets
- **Description**: Sets the Unix socket paths accessible in the sandbox (e.g., SSH agents).
- **Parameters**: allow_unix_sockets (Vec<String>)

### allow_all_unix_sockets
- **Description**: Allows all Unix sockets (less secure).
- **Parameters**: allow_all_unix_sockets (bool)

### allow_local_binding
- **Description**: Allows binding to localhost ports (macOS only).
- **Parameters**: allow_local_binding (bool)

### http_proxy_port
- **Description**: Sets the HTTP proxy port if using a custom proxy.
- **Parameters**: http_proxy_port (u16)

### socks_proxy_port
- **Description**: Sets the SOCKS5 proxy port if using a custom proxy.
- **Parameters**: socks_proxy_port (u16)

### build
- **Description**: Finalizes the builder and returns a SandboxNetworkConfig instance.
```

--------------------------------

### Unsafely Unwrap `Err` Value with `unwrap_err_unchecked`

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `unwrap_err_unchecked` to get the `Err` value without checking if it's an `Ok`. This is unsafe and calling it on an `Ok` results in undefined behavior.

```rust
let x: Result<u32, &str> = Ok(2);
unsafe { x.unwrap_err_unchecked() }; // Undefined behavior!
```

```rust
let x: Result<u32, &str> = Err("emergency failure");
assert_eq!(unsafe { x.unwrap_err_unchecked() }, "emergency failure");
```

--------------------------------

### Create HookMatcher Builder

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/struct.HookMatcher.html

Initiates the building process for a HookMatcher. Use the builder methods to set optional fields like matcher, hooks, and timeout before calling build().

```rust
pub fn builder() -> HookMatcherBuilder<((), (), ())>
```

--------------------------------

### Unsafely Unwrap `Ok` Value with `unwrap_unchecked`

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `unwrap_unchecked` to get the `Ok` value without checking if it's an `Err`. This is unsafe and calling it on an `Err` results in undefined behavior.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(unsafe { x.unwrap_unchecked() }, 2);
```

```rust
let x: Result<u32, &str> = Err("emergency failure");
unsafe { x.unwrap_unchecked() }; // Undefined behavior!
```

--------------------------------

### Expect Error Value with Panic Message

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `expect_err` to get the contained `Err` value. Panics if the value is an `Ok`, including the provided message and the `Ok`'s content.

```rust
let x: Result<u32, &str> = Ok(10);
x.expect_err("Testing expect_err"); // panics with `Testing expect_err: 10`
```

--------------------------------

### Constructing an Arc

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Basic usage for creating a new Arc instance.

```rust
use std::sync::Arc;

let five = Arc::new(5);
```

--------------------------------

### Get Strong Reference Count

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

Retrieves the number of strong (`Arc`) pointers pointing to the allocation. The allocator `A` must implement `Clone`. Be aware that the count can change concurrently in multithreaded scenarios.

```rust
use std::sync::Arc;

let five = Arc::new(5);
let _also_five = Arc::clone(&five);

// This assertion is deterministic because we haven't shared
// the `Arc` between threads.
assert_eq!(2, Arc::strong_count(&five));

```

--------------------------------

### SandboxSettings Builder API

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SandboxSettings.html

API for building SandboxSettings instances using a fluent builder pattern.

```APIDOC
### impl SandboxSettings

#### pub fn builder() -> SandboxSettingsBuilder<((), (), (), (), (), (), ())>
Create a builder for building `SandboxSettings`. On the builder, call `.enabled(...)`(optional), `.auto_allow_bash_if_sandboxed(...)`(optional), `.excluded_commands(...)`(optional), `.allow_unsandboxed_commands(...)`(optional), `.network(...)`(optional), `.ignore_violations(...)`(optional), `.enable_weaker_nested_sandbox(...)`(optional) to set the values of the fields. Finally, call `.build()` to create the instance of `SandboxSettings`.
```

--------------------------------

### Implement Clone for McpSdkServerConfig

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/mcp/struct.McpSdkServerConfig.html

Provides functionality to create a duplicate of an McpSdkServerConfig instance.

```rust
fn clone(&self) -> McpSdkServerConfig
```

--------------------------------

### SandboxNetworkConfig Implementations

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SandboxNetworkConfig.html

Details on the implementations available for the SandboxNetworkConfig struct, including Clone, Debug, Default, Deserialize, and Serialize.

```APIDOC
### impl Clone for SandboxNetworkConfig
#### `clone(&self) -> SandboxNetworkConfig`
Returns a duplicate of the value.
#### `clone_from(&mut self, source: &Self)`
Performs copy-assignment from `source`.

### impl Debug for SandboxNetworkConfig
#### `fmt(&self, f: &mut Formatter<'_>) -> Result`
Formats the value using the given formatter.

### impl Default for SandboxNetworkConfig
#### `default() -> SandboxNetworkConfig`
Returns the “default value” for a type.

### impl<'de> Deserialize<'de> for SandboxNetworkConfig
#### `deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>`
Deserialize this value from the given Serde deserializer.

### impl Serialize for SandboxNetworkConfig
#### `serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>`
Serialize this value into the given Serde serializer.
```

--------------------------------

### Drop an Arc<T>

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Decrements the strong reference count. If the count reaches zero, the inner value is dropped. This example demonstrates how dropping a cloned `Arc` can trigger the `Drop` implementation of the inner type.

```rust
use std::sync::Arc;

struct Foo;

impl Drop for Foo {
    fn drop(&mut self) {
        println!("dropped!");
    }
}

let foo  = Arc::new(Foo);
let foo2 = Arc::clone(&foo);

drop(foo);    // Doesn't print anything
drop(foo2);   // Prints "dropped!"
```

--------------------------------

### Lazily Compute Default Value with `unwrap_or_else`

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/errors/type.Result.html

Use `unwrap_or_else` to get the `Ok` value or compute a default value using a closure if `self` is `Err`. This is useful for lazily evaluating default value computation.

```rust
fn count(x: &str) -> usize { x.len() }

assert_eq!(Ok(2).unwrap_or_else(count), 2);
assert_eq!(Err("foo").unwrap_or_else(count), 3);
```

--------------------------------

### Clone From SandboxSettings

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/config/struct.SandboxSettings.html

Implements the clone_from method for SandboxSettings, enabling copy-assignment from another SandboxSettings instance. This modifies the current instance in place.

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### Try to Unwrap Arc

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/hooks/type.HookCallback.html

Use `try_unwrap` to get the inner value of an `Arc` if it has exactly one strong reference. Returns an `Err` with the `Arc` if there are multiple strong references. This method succeeds even if weak references exist.

```rust
use std::sync::Arc;

let x = Arc::new(3);
assert_eq!(Arc::try_unwrap(x), Ok(3));

let x = Arc::new(4);
let _y = Arc::clone(&x);
assert_eq!(*Arc::try_unwrap(x).unwrap_err(), 4);
```

--------------------------------

### Send Query with Structured Content (including images)

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/client/struct.ClaudeClient.html

Enables multimodal queries by sending structured content blocks, including text and base64 encoded images. Requires the content vector to be non-empty.

```rust
let base64_data = "iVBORw0KGgo..."; // base64 encoded image
client.query_with_content(vec![
    UserContentBlock::text("What's in this image?"),
    UserContentBlock::image_base64("image/png", base64_data)?,
]).await?;
```

--------------------------------

### Convert Slice to Array Arc with Allocator

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/permissions/type.CanUseToolCallback.html

This example demonstrates converting a slice `Arc` back into an array `Arc` using `from_raw_in` and `cast`. It requires the `allocator_api` feature and is nightly-only. Ensure correct type casting for memory safety.

```rust
#![feature(allocator_api)]

use std::sync::Arc;
use std::alloc::System;

let x: Arc<[u32], _> = Arc::new_in([1, 2, 3], System);
let x_ptr: *const [u32] = Arc::into_raw_with_allocator(x).0;

unsafe {
    let x: Arc<[u32; 3], _> = Arc::from_raw_in(x_ptr.cast::<[u32; 3]>(), System);
    assert_eq!(&*x, &[1, 2, 3]);
}
```

--------------------------------

### Create EfficiencyConfig with only CWD reminder enabled

Source: https://docs.rs/claude-agent-sdk-rs/latest/claude_agent_sdk_rs/types/efficiency/struct.EfficiencyConfig.html

Instantiate a new EfficiencyConfig with only the working directory reminder feature enabled. Use this when you only need to inject the current working directory reminder.

```rust
pub fn cwd_reminder_only() -> Self
```
Tokens:
Raw