Struct ToolContext 

pub struct ToolContext { /* private fields */ }

Context passed to tool executions.

MCP-backed tool calls receive a request-scoped cancellation token through this context. Non-MCP callers that construct ToolContext::default or ToolContext::new receive a never-cancelled context so existing direct, native, and NAPI entrypoints remain source-compatible.

Tool authors should prefer these helpers instead of wiring cancellation by hand:

• ToolContext::run_cancellable for a single async operation that should abort promptly when the request is cancelled.
• ToolContext::cancelled when cancellation must participate in a larger tokio::select!.
• ToolContext::is_cancelled for quick boundary checks before starting more work.
• ToolContext::cancellation_token when an owned token clone must cross .await boundaries inside a BoxFuture<'static> implementation.

Cancellation maps to ToolError::Cancelled. Returning that error means the tool stopped because the caller cancelled the request, not because the tool failed.

For subprocess-managing tools, request cancellation should trigger explicit cleanup before returning. Dropping a future remains a backstop, not the primary cooperative cleanup path.

Implementations

impl ToolContext

pub fn new() -> Self

Create a new default context.

pub fn with_cancel(cancel: CancellationToken) -> Self

Create a context backed by the supplied cancellation token.

pub fn cancellation_token(&self) -> CancellationToken

Clone the request cancellation token for use across .await boundaries.

pub fn cancelled(&self) -> WaitForCancellationFutureOwned

Return an owned future that resolves when the request is cancelled.

pub fn is_cancelled(&self) -> bool

Check whether the request has already been cancelled.

pub async fn run_cancellable<F, T, E>(&self, fut: F) -> Result<T, ToolError>

where F: Future<Output = Result<T, E>>, E: Into<ToolError>,

Run an async operation that should stop promptly on request cancellation.

Trait Implementations

impl Clone for ToolContext

fn clone(&self) -> ToolContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolContext

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

Formats the value using the given formatter.

impl Default for ToolContext

fn default() -> Self

Returns the “default value” for a type.