Skip to main content

ProtocolServer

Struct ProtocolServer 

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

Bridge protocol server — wraps an AgentRuntime and exposes it over the NDJSON bridge protocol for external SDK consumption.

Manages sessions, tool registration via proxy tools, and event forwarding. Tool calls use a single-slot pattern: the serve loop pushes a receiver before each tool call, and ProxyTool pops it.

Implementations§

Source§

impl ProtocolServer

Source

pub fn new(runtime: AgentRuntime) -> Self

Wrap an existing AgentRuntime in a protocol server.

Source

pub fn from_builder(builder: AgentBuilder) -> Result<Self, AgentError>

Build a protocol server from an AgentBuilder.

Source

pub async fn register_tool( &self, name: String, description: String, parameters: Value, )

Register a tool implemented on the SDK side.

The tool’s call will block until the SDK sends a tool_result message through the bridge.

Source

pub async fn prepare_tool_call( &self, ) -> UnboundedSender<AgentResult<Vec<Content>>>

Set up the response channel for the NEXT tool call. Returns the sender — keep it; send the result when the SDK replies.

Source

pub async fn create_session( &self, external_id: Option<String>, ) -> (SessionId, Option<String>)

Create a new session, optionally with an external ID for reuse.

Source

pub async fn get_or_create_session( &self, external_id: Option<String>, ) -> SessionId

Get or create a session by external_id.

If external_id is Some and a session with that id already exists, it is reused (preserving conversation history). Otherwise a new session is created and registered.

Source

pub fn subscribe_events(&self) -> Receiver<RuntimeEvent>

Subscribe to runtime events broadcast by the agent.

Source

pub async fn run_turn<F>( &self, sid: &SessionId, input: &str, f: F, ) -> AgentResult<RunOutcome>
where F: FnMut(RuntimeEvent) -> AgentResult<()> + Send + 'static,

Run a turn on the given session, forwarding events to the callback.

Source

pub fn cancel(&self)

Cancel the currently running turn.

Source

pub async fn list_tools(&self) -> Vec<ToolMetadata>

List all registered tools with their metadata, sorted by name.

Trait Implementations§

Source§

impl Clone for ProtocolServer

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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> CloneToUninit for T
where T: Clone,

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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