Class InMemoryTaskStore`Experimental`

In-memory TaskStore implementation for development and testing. For production, use a database or distributed cache.

Implements

TaskStore

Index

Constructors

constructor

Methods

cleanup createTask getAllTasks getTask getTaskResult listTasks storeTaskResult updateTaskStatus

Constructors

constructor

new InMemoryTaskStore(): InMemoryTaskStore
Experimental
Returns InMemoryTaskStore

Methods

cleanup

cleanup(): void
Experimental
Cleanup all timers (useful for testing or graceful shutdown)

Returns void
- Defined in packages/core/src/experimental/tasks/stores/inMemory.ts:224

createTask

createTask(
    taskParams: CreateTaskOptions,
    requestId: RequestId,
    request: {
        method: string;
        params?: {
            _meta?: {
                "io.modelcontextprotocol/related-task"?: { taskId: string };
                progressToken?: string | number;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        };
    },
    sessionId?: string,
): Promise<
    {
        createdAt: string;
        lastUpdatedAt: string;
        pollInterval?: number;
        status: | "working"
        | "input_required"
        | "completed"
        | "failed"
        | "cancelled";
        statusMessage?: string;
        taskId: string;
        ttl: number
        | null;
    },
>
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?: {
              "io.modelcontextprotocol/related-task"?: { taskId: string };
              progressToken?: string | number;
              [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<
    {
        createdAt: string;
        lastUpdatedAt: string;
        pollInterval?: number;
        status: | "working"
        | "input_required"
        | "completed"
        | "failed"
        | "cancelled";
        statusMessage?: string;
        taskId: string;
        ttl: number
        | null;
    },
>
The created Task object
Implementation of TaskStore.createTask
- Defined in packages/core/src/experimental/tasks/stores/inMemory.ts:35

getAllTasks

getAllTasks(): {
    createdAt: string;
    lastUpdatedAt: string;
    pollInterval?: number;
    status: "working"
    | "input_required"
    | "completed"
    | "failed"
    | "cancelled";
    statusMessage?: string;
    taskId: string;
    ttl: number | null;
}[]
Experimental
Get all tasks (useful for debugging)

Returns {
    createdAt: string;
    lastUpdatedAt: string;
    pollInterval?: number;
    status: "working" | "input_required" | "completed" | "failed" | "cancelled";
    statusMessage?: string;
    taskId: string;
    ttl: number | null;
}[]
- createdAt: string
  ISO 8601 timestamp when the task was created.
- lastUpdatedAt: string
  ISO 8601 timestamp when the task was last updated.
- OptionalpollInterval?: number
- status: "working" | "input_required" | "completed" | "failed" | "cancelled"
- OptionalstatusMessage?: string
  Optional diagnostic message for failed tasks or other status information.
- taskId: string
- ttl: number | null
  Time in milliseconds to keep task results available after completion. If null, the task has unlimited lifetime until manually cleaned up.
- Defined in packages/core/src/experimental/tasks/stores/inMemory.ts:235

getTask

getTask(
    taskId: string,
    sessionId?: string,
): Promise<
    | {
        createdAt: string;
        lastUpdatedAt: string;
        pollInterval?: number;
        status: | "working"
        | "input_required"
        | "completed"
        | "failed"
        | "cancelled";
        statusMessage?: string;
        taskId: string;
        ttl: number
        | null;
    }
    | null,
>
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<
    | {
        createdAt: string;
        lastUpdatedAt: string;
        pollInterval?: number;
        status: | "working"
        | "input_required"
        | "completed"
        | "failed"
        | "cancelled";
        statusMessage?: string;
        taskId: string;
        ttl: number
        | null;
    }
    | null,
>
The Task object, or null if it does not exist
Implementation of TaskStore.getTask
- Defined in packages/core/src/experimental/tasks/stores/inMemory.ts:95

getTaskResult

getTaskResult(
    taskId: string,
    sessionId?: string,
): Promise<
    {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
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?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
The stored result
Implementation of TaskStore.getTaskResult
- Defined in packages/core/src/experimental/tasks/stores/inMemory.ts:135

listTasks

listTasks(
    cursor?: string,
    sessionId?: string,
): Promise<
    {
        nextCursor?: string;
        tasks: {
            createdAt: string;
            lastUpdatedAt: string;
            pollInterval?: number;
            status: | "working"
            | "input_required"
            | "completed"
            | "failed"
            | "cancelled";
            statusMessage?: string;
            taskId: string;
            ttl: number
            | null;
        }[];
    },
>
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<
    {
        nextCursor?: string;
        tasks: {
            createdAt: string;
            lastUpdatedAt: string;
            pollInterval?: number;
            status: | "working"
            | "input_required"
            | "completed"
            | "failed"
            | "cancelled";
            statusMessage?: string;
            taskId: string;
            ttl: number
            | null;
        }[];
    },
>
An object containing the tasks array and an optional nextCursor
Implementation of TaskStore.listTasks
- Defined in packages/core/src/experimental/tasks/stores/inMemory.ts:186

storeTaskResult

storeTaskResult(
    taskId: string,
    status: "completed" | "failed",
    result: {
        _meta?: {
            "io.modelcontextprotocol/related-task"?: { taskId: string };
            progressToken?: string | number;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
    sessionId?: string,
): Promise<void>
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?: {
          "io.modelcontextprotocol/related-task"?: { taskId: string };
          progressToken?: string | number;
          [key: string]: unknown;
      };
      [key: string]: unknown;
  }
  The result to store
  - [key: string]: unknown
  - Optional_meta?: {
        "io.modelcontextprotocol/related-task"?: { taskId: string };
        progressToken?: string | number;
        [key: string]: unknown;
    }
    See MCP specification for notes on _meta usage.
    
    Optionalio.modelcontextprotocol/related-task?: { taskId: string }
    If specified, this request is related to the provided task.
    
    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.
- OptionalsessionId: string
  Optional session ID for binding the operation to a specific session
Returns Promise<void>
Implementation of TaskStore.storeTaskResult
- Defined in packages/core/src/experimental/tasks/stores/inMemory.ts:101

updateTaskStatus

updateTaskStatus(
    taskId: string,
    status: "working" | "input_required" | "completed" | "failed" | "cancelled",
    statusMessage?: string,
    sessionId?: string,
): Promise<void>
Experimental
Updates a task's status (e.g., to 'cancelled', 'failed', 'completed').
Parameters
- taskId: string
  The task identifier
- status: "working" | "input_required" | "completed" | "failed" | "cancelled"
  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>
Implementation of TaskStore.updateTaskStatus
- Defined in packages/core/src/experimental/tasks/stores/inMemory.ts:149

Class InMemoryTaskStoreExperimental

Implements

Index

Constructors

Methods

Constructors

constructor

Returns InMemoryTaskStore

Methods

cleanup

Returns void

createTask

Parameters

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

getAllTasks

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

createdAt: string

lastUpdatedAt: string

OptionalpollInterval?: number

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

OptionalstatusMessage?: string

taskId: string

ttl: number | null

getTask

Parameters

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

getTaskResult

Parameters

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

listTasks

Parameters

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

storeTaskResult

Parameters

[key: string]: unknown

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

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

OptionalprogressToken?: string | number

Returns Promise<void>

updateTaskStatus

Parameters

Returns Promise<void>

Settings

On This Page

Class InMemoryTaskStore`Experimental`

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

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

`Optional`pollInterval?: number

`Optional`statusMessage?: string

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

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

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

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

`Optional`io.modelcontextprotocol/related-task?: { taskId: string }

`Optional`progressToken?: string | number