Class ToolRegistry

Registry for MCP tools that implements ToolProvider.

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

Example

import { toolRegistry, defineTool } from 'mcp-server-framework';

// Tools are auto-registered via defineTool()
defineTool({ name: 'greet', ... });

// Registry can be used directly as a provider
builder.withToolProvider(toolRegistry);

Hierarchy

BaseRegistry<ToolDefinition>
- ToolRegistry

Implements

ToolProvider

Index

Constructors

constructor

new ToolRegistry(): ToolRegistry
Returns ToolRegistry
Inherited from BaseRegistry<ToolDefinition>.constructor

Properties

`Protected` `Readonly`items

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

Internal storage

Accessors

`Protected`itemTypeName

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

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

size

get size(): number
Number of registered items.

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

Methods

[iterator]

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

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

clear

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

getAll

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

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

getTools

getTools(): readonly ToolDefinition<ZodTypeAny>[]
Get all registered tools.

Returns readonly ToolDefinition<ZodTypeAny>[]
Readonly array of all tools
Implementation of ToolProvider.getTools
- Defined in src/mcp/capabilities/registry/tool-registry.ts:130

has

has(name: string): boolean
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: ToolDefinition): void
Register a new item. Throws if name already exists.
Parameters
- item: ToolDefinition
  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: ToolDefinition): boolean
Register or replace an existing item.
Parameters
- item: ToolDefinition
  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
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(): ToolRegistry
Creates an isolated ToolRegistry (no shared global state).

Used for testing.

Returns ToolRegistry
- Defined in src/mcp/capabilities/registry/tool-registry.ts:88

Class ToolRegistry

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ToolRegistry

Properties

Protected Readonlyitems

Accessors

ProtecteditemTypeName

Returns string

size

Returns number

Methods

[iterator]

Returns Iterator<ToolDefinition<ZodTypeAny>>

clear

Returns void

get

Parameters

Returns ToolDefinition<ZodTypeAny> | undefined

getAll

Returns readonly ToolDefinition<ZodTypeAny>[]

getTools

Returns readonly ToolDefinition<ZodTypeAny>[]

has

Parameters

Returns boolean

register

Parameters

Returns void

Throws

registerOrReplace

Parameters

Returns boolean

unregister

Parameters

Returns boolean

StaticcreateIsolated

Returns ToolRegistry

Settings

On This Page

`Protected` `Readonly`items

`Protected`itemTypeName

`Static`createIsolated