Class ExperimentalMcpServerTasks`Experimental`

Experimental task features for McpServer.

Access via server.experimental.tasks:

server.experimental.tasks.registerToolTask('long-running', config, handler);

Index

Constructors

constructor

Methods

registerToolTask

Constructors

constructor

new ExperimentalMcpServerTasks(
_mcpServer: McpServer,
): ExperimentalMcpServerTasks
Experimental
Parameters
- _mcpServer: McpServer
Returns ExperimentalMcpServerTasks
- Defined in src/experimental/tasks/mcp-server.ts:42

Methods

registerToolTask

registerToolTask<OutputArgs extends AnySchema | ZodRawShapeCompat | undefined>(
    name: string,
    config: {
        _meta?: Record<string, unknown>;
        annotations?: {
            destructiveHint?: boolean;
            idempotentHint?: boolean;
            openWorldHint?: boolean;
            readOnlyHint?: boolean;
            title?: string;
        };
        description?: string;
        execution?: TaskToolExecution;
        outputSchema?: OutputArgs;
        title?: string;
    },
    handler: ToolTaskHandler<undefined>,
): RegisteredTool
Experimental
Registers a task-based tool with a config object and handler.

Task-based tools support long-running operations that can be polled for status and results. The handler must implement createTask, getTask, and getTaskResult methods.
Type Parameters
- OutputArgs extends AnySchema | ZodRawShapeCompat | undefined
Parameters
- name: string
  The tool name
- config: {
      _meta?: Record<string, unknown>;
      annotations?: {
          destructiveHint?: boolean;
          idempotentHint?: boolean;
          openWorldHint?: boolean;
          readOnlyHint?: boolean;
          title?: string;
      };
      description?: string;
      execution?: TaskToolExecution;
      outputSchema?: OutputArgs;
      title?: string;
  }
  Tool configuration (description, schemas, etc.)
- handler: ToolTaskHandler<undefined>
  Task handler with createTask, getTask, getTaskResult methods
Returns RegisteredTool
RegisteredTool for managing the tool's lifecycle
Example
```
server.experimental.tasks.registerToolTask('long-computation', {
  description: 'Performs a long computation',
  inputSchema: { input: z.string() },
  execution: { taskSupport: 'required' }
}, {
  createTask: async (args, extra) => {
    const task = await extra.taskStore.createTask({ ttl: 300000 });
    startBackgroundWork(task.taskId, args);
    return { task };
  },
  getTask: async (args, extra) => {
    return extra.taskStore.getTask(extra.taskId);
  },
  getTaskResult: async (args, extra) => {
    return extra.taskStore.getTaskResult(extra.taskId);
  }
});
```
- Defined in src/experimental/tasks/mcp-server.ts:79
registerToolTask<
    InputArgs extends AnySchema
    | ZodRawShapeCompat,
    OutputArgs extends AnySchema | ZodRawShapeCompat | undefined,
>(
    name: string,
    config: {
        _meta?: Record<string, unknown>;
        annotations?: {
            destructiveHint?: boolean;
            idempotentHint?: boolean;
            openWorldHint?: boolean;
            readOnlyHint?: boolean;
            title?: string;
        };
        description?: string;
        execution?: TaskToolExecution;
        inputSchema: InputArgs;
        outputSchema?: OutputArgs;
        title?: string;
    },
    handler: ToolTaskHandler<InputArgs>,
): RegisteredTool
Experimental
Registers a task-based tool with a config object and handler.

Task-based tools support long-running operations that can be polled for status and results. The handler must implement createTask, getTask, and getTaskResult methods.
Type Parameters
- InputArgs extends AnySchema | ZodRawShapeCompat
- OutputArgs extends AnySchema | ZodRawShapeCompat | undefined
Parameters
- name: string
  The tool name
- config: {
      _meta?: Record<string, unknown>;
      annotations?: {
          destructiveHint?: boolean;
          idempotentHint?: boolean;
          openWorldHint?: boolean;
          readOnlyHint?: boolean;
          title?: string;
      };
      description?: string;
      execution?: TaskToolExecution;
      inputSchema: InputArgs;
      outputSchema?: OutputArgs;
      title?: string;
  }
  Tool configuration (description, schemas, etc.)
- handler: ToolTaskHandler<InputArgs>
  Task handler with createTask, getTask, getTaskResult methods
Returns RegisteredTool
RegisteredTool for managing the tool's lifecycle
Example
```
server.experimental.tasks.registerToolTask('long-computation', {
  description: 'Performs a long computation',
  inputSchema: { input: z.string() },
  execution: { taskSupport: 'required' }
}, {
  createTask: async (args, extra) => {
    const task = await extra.taskStore.createTask({ ttl: 300000 });
    startBackgroundWork(task.taskId, args);
    return { task };
  },
  getTask: async (args, extra) => {
    return extra.taskStore.getTask(extra.taskId);
  },
  getTaskResult: async (args, extra) => {
    return extra.taskStore.getTaskResult(extra.taskId);
  }
});
```
- Defined in src/experimental/tasks/mcp-server.ts:92

Class ExperimentalMcpServerTasks`Experimental`

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ExperimentalMcpServerTasks

Methods

registerToolTask

Type Parameters

Parameters

Returns RegisteredTool

Example

Type Parameters

Parameters

Returns RegisteredTool

Example

Settings

On This Page

Class ExperimentalMcpServerTasksExperimental

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ExperimentalMcpServerTasks

Methods

registerToolTask

Type Parameters

Parameters

Returns RegisteredTool

Example

Type Parameters

Parameters

Returns RegisteredTool

Example

Settings

On This Page

Class ExperimentalMcpServerTasks`Experimental`