FastestMCP.Client.Task (fastest_mcp v0.3.0)

Copy Markdown View Source

Connected-client handle for one remote MCP task.

This is intentionally different from %FastestMCP.BackgroundTask{}, which is a local runtime handle. A remote client task is a view over a task owned by a connected peer.

The flow is:

create task remotely
-> register the remote task handle in the client
-> wait on task notifications when available
-> fall back to tasks/get polling when needed
-> cache the final result payload

Summary

Types

kind()
t()

Functions

cancel(task, opts \\ [])

Signals cancellation to the remote task.

fetch(task, opts \\ [])

Fetches fresh task status from the remote peer and updates the cache.

on_status_change(task, callback)

Registers a callback for task status changes.

result(task, opts \\ [])

Fetches and caches the final task result.

status(task)

Returns the last cached status, if any.

update(task, input_responses, opts \\ [])

Supplies responses to outstanding input requests for this task.

wait(task, opts \\ [])

Waits for the task to reach a target state or any terminal state.

Types

kind()

@type kind() :: :tool | :prompt | :resource | :generic

t()

@type t() :: %FastestMCP.Client.Task{
  client: FastestMCP.Client.t(),
  kind: kind(),
  target: String.t() | nil,
  task_id: String.t()
}

Functions

cancel(task, opts \\ [])

Signals cancellation to the remote task.

fetch(task, opts \\ [])

Fetches fresh task status from the remote peer and updates the cache.

on_status_change(task, callback)

Registers a callback for task status changes.

result(task, opts \\ [])

Fetches and caches the final task result.

status(task)

Returns the last cached status, if any.

update(task, input_responses, opts \\ [])

Supplies responses to outstanding input requests for this task.

wait(task, opts \\ [])

Waits for the task to reach a target state or any terminal state.