Struct CopilotSdkConfig 

pub struct CopilotSdkConfig {
    pub runtime_path: Option<PathBuf>,
    pub base_directory: PathBuf,
    pub model: String,
    pub github_token: Option<String>,
    pub provider: Option<CopilotSdkProvider>,
    pub permission_policy: PermissionPolicy,
    pub max_history_turns: usize,
    pub mcp_tool_calling: bool,
    pub prompt_timeout: Duration,
    pub session_timeout: Duration,
}

Configuration for the Copilot SDK provider.

Fields

runtime_path: Option<PathBuf>

Path to the copilot-runtime wrapper. runtime.node must sit next to it. None lets the SDK resolve COPILOT_CLI_PATH itself; there is no PATH scan.

base_directory: PathBuf

Directory the runtime treats as its home (COPILOT_HOME): session state, credential store, logs. Required because the client runs in ClientMode::Empty, which refuses to fall back to ~/.copilot.

model: String

Model used when a request names none.

github_token: Option<String>

GitHub token the runtime authenticates with; None uses the runtime’s stored login.

provider: Option<CopilotSdkProvider>

Route sessions to this model provider instead of GitHub Copilot. None is Copilot’s own routing, checked against its catalogue.

permission_policy: PermissionPolicy

Policy for handling permission requests from the runtime.

max_history_turns: usize

Maximum number of prior conversation messages (user + assistant) rendered into the prompt for multi-turn context. Set to 0 to disable history.

mcp_tool_calling: bool

Advertise SDK_TOOL_CALLING so callers route tool turns through HeadlessTurnProvider::converse with per-request MCP servers (native tool calling), instead of falling through to text-based <tool_call> parsing. Default: false.

prompt_timeout: Duration

Bound on one turn, prompt sent to session idle.

session_timeout: Duration

Bound on client start and session creation.

Implementations

impl CopilotSdkConfig

pub fn from_env() -> Self

Create configuration from environment variables.

Environment variables:

• COPILOT_RUNTIME_PATH — Path to the copilot-runtime wrapper (runtime.node adjacent); unset lets the SDK resolve COPILOT_CLI_PATH
• COPILOT_SDK_HOME — The runtime’s home directory (default: a per-process directory under the system temp dir)
• COPILOT_SDK_MODEL — Default model (defaults to the top-ranked candidate in crate::copilot_models::CATALOG)
• COPILOT_GITHUB_TOKEN / GH_TOKEN / GITHUB_TOKEN — GitHub auth token
• COPILOT_PROVIDER_BASE_URL — Route sessions to this model provider instead of GitHub Copilot (see CopilotSdkProvider::from_env), with COPILOT_PROVIDER_TYPE, COPILOT_PROVIDER_API_KEY and COPILOT_PROVIDER_MAX_PROMPT_TOKENS
• COPILOT_SDK_PERMISSION_POLICY — auto_approve to approve the runtime’s permission prompts; anything else denies
• COPILOT_SDK_MAX_HISTORY_TURNS — Max conversation history turns (default: 20)
• COPILOT_SDK_MCP_TOOL_CALLING — Advertise SDK_TOOL_CALLING for native MCP tool calling (default: false)
• EMBACLE_SDK_PROMPT_TIMEOUT_SECS — Bound on one turn (default: 300)
• EMBACLE_SDK_SESSION_TIMEOUT_SECS — Bound on client start and session creation (default: 60)

Trait Implementations

impl Clone for CopilotSdkConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CopilotSdkConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CopilotSdkConfig

fn default() -> Self

Returns the “default value” for a type.