Class ResourceRegistry

Composite registry for MCP resources and templates.

Uses two internal BaseRegistry instances to eliminate code duplication while maintaining separate namespaces for resources and templates.

Implements ResourceProvider for direct use with McpServerBuilder.

Example

import { resourceRegistry, defineResource } from 'mcp-server-framework';

// Resources are auto-registered via defineResource()
defineResource({ name: 'config', uri: 'app://config', ... });

// Registry can be used directly as a provider
builder.withResourceProvider(resourceRegistry);

Implements

ResourceProvider

Constructors

constructor

new ResourceRegistry(): ResourceRegistry
Returns ResourceRegistry

Accessors

resourceCount

get resourceCount(): number
Number of registered resources.

Returns number
- Defined in src/mcp/capabilities/registry/resource-registry.ts:261

templateCount

get templateCount(): number
Number of registered templates.

Returns number
- Defined in src/mcp/capabilities/registry/resource-registry.ts:266

Methods

clear

clear(): void
Clear all resources and templates.

Returns void
- Defined in src/mcp/capabilities/registry/resource-registry.ts:251

clearResources

clearResources(): void
Clear all resources.

Returns void
- Defined in src/mcp/capabilities/registry/resource-registry.ts:241

clearTemplates

clearTemplates(): void
Clear all templates.

Returns void
- Defined in src/mcp/capabilities/registry/resource-registry.ts:246

getResource

getResource(name: string): ResourceStaticDefinition | undefined
Get a resource by name.
Parameters
- name: string
Returns ResourceStaticDefinition | undefined
- Defined in src/mcp/capabilities/registry/resource-registry.ts:156

hasResource

hasResource(name: string): boolean
Check if a resource exists.
Parameters
- name: string
Returns boolean
- Defined in src/mcp/capabilities/registry/resource-registry.ts:161

hasResources

hasResources(): boolean
Check if provider has any resources or templates.

Returns boolean
Implementation of ResourceProvider.hasResources
- Defined in src/mcp/capabilities/registry/resource-registry.ts:291

hasTemplate

hasTemplate(name: string): boolean
Check if a template exists.
Parameters
- name: string
Returns boolean
- Defined in src/mcp/capabilities/registry/resource-registry.ts:190

registerOrReplaceResource

registerOrReplaceResource(resource: ResourceStaticDefinition): void
Register a static resource, replacing any existing. Warns on URI conflict.
Parameters
- resource: ResourceStaticDefinition
Returns void
- Defined in src/mcp/capabilities/registry/resource-registry.ts:145

registerOrReplaceTemplate

registerOrReplaceTemplate(template: ResourceTemplateDefinition): void
Register a template, replacing any existing.
Parameters
- template: ResourceTemplateDefinition
Returns void
- Defined in src/mcp/capabilities/registry/resource-registry.ts:175

registerResource

registerResource(resource: ResourceStaticDefinition): void
Register a static resource. Throws if name exists. Warns on URI conflict.
Parameters
- resource: ResourceStaticDefinition
Returns void
- Defined in src/mcp/capabilities/registry/resource-registry.ts:139

registerTemplate

registerTemplate(template: ResourceTemplateDefinition): void
Register a resource template. Throws if name exists.
Parameters
- template: ResourceTemplateDefinition
Returns void
- Defined in src/mcp/capabilities/registry/resource-registry.ts:170

unregisterResource

unregisterResource(name: string): boolean
Unregister a resource by name.
Parameters
- name: string
Returns boolean
- Defined in src/mcp/capabilities/registry/resource-registry.ts:151

unregisterTemplate

unregisterTemplate(name: string): boolean
Unregister a template by name.
Parameters
- name: string
Returns boolean
- Defined in src/mcp/capabilities/registry/resource-registry.ts:180

`Static`createIsolated

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

Used for testing.

Returns ResourceRegistry
- Defined in src/mcp/capabilities/registry/resource-registry.ts:130

Class ResourceRegistry

Example

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns ResourceRegistry

Accessors

resourceCount

Returns number

templateCount

Returns number

Methods

clear

Returns void

clearResources

Returns void

clearTemplates

Returns void

getResource

Parameters

Returns ResourceStaticDefinition | undefined

getResources

Returns readonly ResourceStaticDefinition[]

getTemplate

Parameters

Returns ResourceTemplateDefinition<AnyZodObject> | undefined

getTemplates

Returns readonly ResourceTemplateDefinition<AnyZodObject>[]

hasResource

Parameters

Returns boolean

hasResources

Returns boolean

hasTemplate

Parameters

Returns boolean

registerOrReplaceResource

Parameters

Returns void

registerOrReplaceTemplate

Parameters

Returns void

registerResource

Parameters

Returns void

registerTemplate

Parameters

Returns void

unregisterResource

Parameters

Returns boolean

unregisterTemplate

Parameters

Returns boolean

StaticcreateIsolated

Returns ResourceRegistry

Settings

On This Page

`Static`createIsolated