Class PromptRegistry

Registry for MCP prompts that implements PromptProvider.

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

Example

import { promptRegistry, definePrompt } from 'mcp-server-framework';

// Prompts are auto-registered via definePrompt()
definePrompt({ name: 'explain', ... });

// Registry can be used directly as a provider
builder.withPromptProvider(promptRegistry);

Hierarchy

BaseRegistry<PromptDefinition>
- PromptRegistry

Implements

PromptProvider

Index

Constructors

constructor

new PromptRegistry(): PromptRegistry
Returns PromptRegistry
Inherited from BaseRegistry<PromptDefinition>.constructor

Properties

`Protected` `Readonly`items

items: Map<string, PromptDefinition<AnyZodObject>> = ...

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/prompt-registry.ts:88

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<PromptDefinition<AnyZodObject>>
Iterate over all items.

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

getAll

getAll(): readonly PromptDefinition<AnyZodObject>[]
Get all registered items.

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

getPrompts

getPrompts(): readonly PromptDefinition<AnyZodObject>[]
Get all registered prompts.

Returns readonly PromptDefinition<AnyZodObject>[]
Implementation of PromptProvider.getPrompts
- Defined in src/mcp/capabilities/registry/prompt-registry.ts:119

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

hasPrompts

hasPrompts(): boolean
Check if provider has any prompts.

Returns boolean
Implementation of PromptProvider.hasPrompts
- Defined in src/mcp/capabilities/registry/prompt-registry.ts:126

register

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

Use for testing or when multiple independent registries are needed.

Returns PromptRegistry
- Defined in src/mcp/capabilities/registry/prompt-registry.ts:81

Class PromptRegistry

Example

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PromptRegistry

Properties

Protected Readonlyitems

Accessors

ProtecteditemTypeName

Returns string

size

Returns number

Methods

[iterator]

Returns Iterator<PromptDefinition<AnyZodObject>>

clear

Returns void

get

Parameters

Returns PromptDefinition<AnyZodObject> | undefined

getAll

Returns readonly PromptDefinition<AnyZodObject>[]

getPrompts

Returns readonly PromptDefinition<AnyZodObject>[]

has

Parameters

Returns boolean

hasPrompts

Returns boolean

register

Parameters

Returns void

Throws

registerOrReplace

Parameters

Returns boolean

unregister

Parameters

Returns boolean

StaticcreateIsolated

Returns PromptRegistry

Settings

On This Page

`Protected` `Readonly`items

`Protected`itemTypeName

`Static`createIsolated