Skip to main content

CodexAppServer

Struct CodexAppServer 

Source
pub struct CodexAppServer { /* private fields */ }
Expand description

Client wrapper around the stdio app-server.

Implementations§

Source§

impl CodexAppServer

Source

pub async fn start( config: StdioServerConfig, client: ClientInfo, ) -> Result<Self, McpError>

Launch codex app-server, issue initialize, and return a connected handle.

Source

pub async fn start_experimental( config: StdioServerConfig, client: ClientInfo, ) -> Result<Self, McpError>

Launch with capabilities.experimentalApi=true in the initialize handshake.

Source

pub async fn with_capabilities( config: StdioServerConfig, client: ClientInfo, capabilities: Value, ) -> Result<Self, McpError>

Launch with explicit capabilities to send during initialize.

Source

pub async fn thread_start( &self, params: ThreadStartParams, ) -> Result<AppCallHandle, McpError>

Start a new thread (or use a provided ID) via thread/start.

Source

pub async fn thread_resume( &self, params: ThreadResumeParams, ) -> Result<AppCallHandle, McpError>

Resume an existing thread via thread/resume.

Source

pub async fn thread_list( &self, params: ThreadListParams, ) -> Result<ThreadListResponse, McpError>

List threads via thread/list.

Source

pub async fn thread_fork( &self, params: ThreadForkParams, ) -> Result<ThreadForkResponse, McpError>

Fork an existing thread via thread/fork.

Source

pub async fn turn_start( &self, params: TurnStartParams, ) -> Result<AppCallHandle, McpError>

Start a new turn on a thread via turn/start.

Source

pub async fn turn_start_v2( &self, params: TurnStartParamsV2, ) -> Result<AppCallHandle, McpError>

Start a new turn on a thread via turn/start (pinned fork flow subset).

Source

pub async fn select_last_thread_id( &self, cwd: PathBuf, ) -> Result<Option<String>, McpError>

Select the deterministic “last” thread id using thread/list paging and tuple ordering.

Source

pub async fn turn_interrupt( &self, params: TurnInterruptParams, ) -> Result<AppCallHandle, McpError>

Interrupt an active turn via turn/interrupt.

Source

pub fn cancel(&self, request_id: RequestId) -> Result<(), McpError>

Request cancellation for a pending call.

Source

pub async fn shutdown(&self) -> Result<(), McpError>

Gracefully shut down the app-server.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more