Class TaskToolRegistry`Experimental`

Registry for MCP task tools that implements TaskToolProvider.

Extends BaseRegistry for standard CRUD operations (register, get, has, etc.) and provides bindToSdk() for registering task tools with MCP SDK server instances.

MCP Tasks is an experimental SDK feature

Example

import { globalTaskToolRegistry, defineTask } from 'mcp-server-framework';

// Task tools are auto-registered via defineTask()
defineTask({ name: 'long_job', ... });

// Registry can be used directly as a provider
builder.withTaskToolProvider(globalTaskToolRegistry);

Hierarchy

BaseRegistry<TaskToolDefinition>
- TaskToolRegistry

Implements

TaskToolProvider

Index

Constructors

constructor

new TaskToolRegistry(): TaskToolRegistry
Experimental
Returns TaskToolRegistry
Inherited from BaseRegistry<TaskToolDefinition>.constructor

Properties

`Protected` `Readonly` `Experimental`items

items: Map<string, TaskToolDefinition<ZodTypeAny>> = ...

Internal storage

Accessors

`Protected`itemTypeName

get itemTypeName(): string
Experimental
Human-readable name for error messages (e.g., "Tool", "Resource"). Override in subclasses.

Returns string
Overrides BaseRegistry.itemTypeName
- Defined in src/mcp/capabilities/registry/task-tool-registry.ts:114

size

get size(): number
Experimental
Number of registered items.

Returns number
Inherited from BaseRegistry.size
- Defined in src/mcp/capabilities/registry/base-registry.ts:156

Methods

[iterator]

"[iterator]"(): Iterator<TaskToolDefinition<ZodTypeAny>>
Experimental
Iterate over all items.

Returns Iterator<TaskToolDefinition<ZodTypeAny>>
Inherited from BaseRegistry.[iterator]
- Defined in src/mcp/capabilities/registry/base-registry.ts:163

clear

clear(): void
Experimental
Clear all items from the registry.

Returns void
Inherited from BaseRegistry.clear
- Defined in src/mcp/capabilities/registry/base-registry.ts:112

get

get(name: string): TaskToolDefinition<ZodTypeAny> | undefined
Experimental
Get an item by name.
Parameters
- name: string
  Name of the item
Returns TaskToolDefinition<ZodTypeAny> | undefined
The item or undefined
Inherited from BaseRegistry.get
- Defined in src/mcp/capabilities/registry/base-registry.ts:130

getAll

getAll(): readonly TaskToolDefinition<ZodTypeAny>[]
Experimental
Get all registered items.

Returns readonly TaskToolDefinition<ZodTypeAny>[]
Readonly array of all items
Inherited from BaseRegistry.getAll
- Defined in src/mcp/capabilities/registry/base-registry.ts:149

getTaskTools

getTaskTools(): readonly TaskToolDefinition<ZodTypeAny>[]
Experimental
Get all registered task tools.

Returns readonly TaskToolDefinition<ZodTypeAny>[]
Readonly array of all task tools
Implementation of TaskToolProvider.getTaskTools
- Defined in src/mcp/capabilities/registry/task-tool-registry.ts:144

has

has(name: string): boolean
Experimental
Check if an item exists.
Parameters
- name: string
  Name to check
Returns boolean
true if exists
Inherited from BaseRegistry.has
- Defined in src/mcp/capabilities/registry/base-registry.ts:140

register

register(item: TaskToolDefinition): void
Experimental
Register a new item. Throws if name already exists.
Parameters
- item: TaskToolDefinition
  Item to register
Returns void
Throws
If an item with the same name is already registered
Inherited from BaseRegistry.register
- Defined in src/mcp/capabilities/registry/base-registry.ts:74

registerOrReplace

registerOrReplace(item: TaskToolDefinition): boolean
Experimental
Register or replace an existing item.
Parameters
- item: TaskToolDefinition
  Item to register/replace
Returns boolean
true if replaced, false if new
Inherited from BaseRegistry.registerOrReplace
- Defined in src/mcp/capabilities/registry/base-registry.ts:88

unregister

unregister(name: string): boolean
Experimental
Unregister an item by name.
Parameters
- name: string
  Name of the item to remove
Returns boolean
true if removed, false if not found
Inherited from BaseRegistry.unregister
- Defined in src/mcp/capabilities/registry/base-registry.ts:105

`Static`createIsolated

createIsolated(): TaskToolRegistry
Experimental
Creates an isolated TaskToolRegistry (no shared global state).

Used for testing.

Returns TaskToolRegistry
- Defined in src/mcp/capabilities/registry/task-tool-registry.ts:106

Class TaskToolRegistryExperimental

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TaskToolRegistry

Properties

Protected Readonly Experimentalitems

Accessors

ProtecteditemTypeName

Returns string

size

Returns number

Methods

[iterator]

Returns Iterator<TaskToolDefinition<ZodTypeAny>>

clear

Returns void

get

Parameters

Returns TaskToolDefinition<ZodTypeAny> | undefined

getAll

Returns readonly TaskToolDefinition<ZodTypeAny>[]

getTaskTools

Returns readonly TaskToolDefinition<ZodTypeAny>[]

has

Parameters

Returns boolean

register

Parameters

Returns void

Throws

registerOrReplace

Parameters

Returns boolean

unregister

Parameters

Returns boolean

StaticcreateIsolated

Returns TaskToolRegistry

Settings

On This Page

Class TaskToolRegistry`Experimental`

`Protected` `Readonly` `Experimental`items

`Protected`itemTypeName

`Static`createIsolated