@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface TaskStoreExperimental

    Interface for storing and retrieving task state and results.

    Similar to Transport, this allows pluggable task storage implementations (in-memory, database, distributed cache, etc.).

    interface TaskStore {
        createTask(
            taskParams: CreateTaskOptions,
            requestId: RequestId,
            request: {
                method: string;
                params?: {
                    _meta?: {
                        progressToken?: string | number;
                        "io.modelcontextprotocol/related-task"?: { taskId: string };
                        [key: string]: unknown;
                    };
                    [key: string]: unknown;
                };
            },
            sessionId?: string,
        ): Promise<
            {
                taskId: string;
                status: | "completed"
                | "cancelled"
                | "working"
                | "failed"
                | "input_required";
                ttl: number
                | null;
                createdAt: string;
                lastUpdatedAt: string;
                pollInterval?: number;
                statusMessage?: string;
            },
        >;
        getTask(
            taskId: string,
            sessionId?: string,
        ): Promise<
            | {
                taskId: string;
                status: | "completed"
                | "cancelled"
                | "working"
                | "failed"
                | "input_required";
                ttl: number
                | null;
                createdAt: string;
                lastUpdatedAt: string;
                pollInterval?: number;
                statusMessage?: string;
            }
            | null,
        >;
        storeTaskResult(
            taskId: string,
            status: "completed" | "failed",
            result: {
                _meta?: {
                    progressToken?: string | number;
                    "io.modelcontextprotocol/related-task"?: { taskId: string };
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            },
            sessionId?: string,
        ): Promise<void>;
        getTaskResult(
            taskId: string,
            sessionId?: string,
        ): Promise<
            {
                _meta?: {
                    progressToken?: string
                    | number;
                    "io.modelcontextprotocol/related-task"?: { taskId: string };
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            },
        >;
        updateTaskStatus(
            taskId: string,
            status:
                | "completed"
                | "cancelled"
                | "working"
                | "failed"
                | "input_required",
            statusMessage?: string,
            sessionId?: string,
        ): Promise<void>;
        listTasks(
            cursor?: string,
            sessionId?: string,
        ): Promise<
            {
                tasks: {
                    taskId: string;
                    status: | "completed"
                    | "cancelled"
                    | "working"
                    | "failed"
                    | "input_required";
                    ttl: number
                    | null;
                    createdAt: string;
                    lastUpdatedAt: string;
                    pollInterval?: number;
                    statusMessage?: string;
                }[];
                nextCursor?: string;
            },
        >;
    }

    Implemented by

    Index

    Methods

    createTask getTask storeTaskResult getTaskResult updateTaskStatus listTasks

    Methods

    • Experimental

      Creates a new task with the given creation parameters and original request. The implementation must generate a unique taskId and createdAt timestamp.

      TTL Management:

      • The implementation receives the TTL suggested by the requestor via taskParams.ttl
      • The implementation MAY override the requested TTL (e.g., to enforce limits)
      • The actual TTL used MUST be returned in the Task object
      • Null TTL indicates unlimited task lifetime (no automatic cleanup)
      • Cleanup SHOULD occur automatically after TTL expires, regardless of task status

      Parameters

      • taskParams: CreateTaskOptions

        The task creation parameters from the request (ttl, pollInterval)

      • requestId: RequestId

        The JSON-RPC request ID

      • request: {
            method: string;
            params?: {
                _meta?: {
                    progressToken?: string | number;
                    "io.modelcontextprotocol/related-task"?: { taskId: string };
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            };
        }

        The original request that triggered task creation

      • OptionalsessionId: string

        Optional session ID for binding the task to a specific session

      Returns Promise<
          {
              taskId: string;
              status: | "completed"
              | "cancelled"
              | "working"
              | "failed"
              | "input_required";
              ttl: number
              | null;
              createdAt: string;
              lastUpdatedAt: string;
              pollInterval?: number;
              statusMessage?: string;
          },
      >

      The created task object

    • Experimental

      Gets the current status of a task.

      Parameters

      • taskId: string

        The task identifier

      • OptionalsessionId: string

        Optional session ID for binding the query to a specific session

      Returns Promise<
          | {
              taskId: string;
              status: | "completed"
              | "cancelled"
              | "working"
              | "failed"
              | "input_required";
              ttl: number
              | null;
              createdAt: string;
              lastUpdatedAt: string;
              pollInterval?: number;
              statusMessage?: string;
          }
          | null,
      >

      The task object, or null if it does not exist

    • Experimental

      Stores the result of a task and sets its final status.

      Parameters

      • taskId: string

        The task identifier

      • status: "completed" | "failed"

        The final status: 'completed' for success, 'failed' for errors

      • result: {
            _meta?: {
                progressToken?: string | number;
                "io.modelcontextprotocol/related-task"?: { taskId: string };
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }

        The result to store

        • [key: string]: unknown
        • Optional_meta?: {
              progressToken?: string | number;
              "io.modelcontextprotocol/related-task"?: { taskId: string };
              [key: string]: unknown;
          }

          See MCP specification for notes on _meta usage.

          • OptionalprogressToken?: string | number

            If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.

          • Optionalio.modelcontextprotocol/related-task?: { taskId: string }

            If specified, this request is related to the provided task.

      • OptionalsessionId: string

        Optional session ID for binding the operation to a specific session

      Returns Promise<void>

    • Experimental

      Retrieves the stored result of a task.

      Parameters

      • taskId: string

        The task identifier

      • OptionalsessionId: string

        Optional session ID for binding the query to a specific session

      Returns Promise<
          {
              _meta?: {
                  progressToken?: string
                  | number;
                  "io.modelcontextprotocol/related-task"?: { taskId: string };
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

      The stored result

    • Experimental

      Updates a task's status (e.g., to 'cancelled', 'failed', 'completed').

      Parameters

      • taskId: string

        The task identifier

      • status: "completed" | "cancelled" | "working" | "failed" | "input_required"

        The new status

      • OptionalstatusMessage: string

        Optional diagnostic message for failed tasks or other status information

      • OptionalsessionId: string

        Optional session ID for binding the operation to a specific session

      Returns Promise<void>

    • Experimental

      Lists tasks, optionally starting from a pagination cursor.

      Parameters

      • Optionalcursor: string

        Optional cursor for pagination

      • OptionalsessionId: string

        Optional session ID for binding the query to a specific session

      Returns Promise<
          {
              tasks: {
                  taskId: string;
                  status: | "completed"
                  | "cancelled"
                  | "working"
                  | "failed"
                  | "input_required";
                  ttl: number
                  | null;
                  createdAt: string;
                  lastUpdatedAt: string;
                  pollInterval?: number;
                  statusMessage?: string;
              }[];
              nextCursor?: string;
          },
      >

      An object containing the tasks array and an optional nextCursor

    Settings

    Member Visibility

    On This Page

    Methods