Skip to main content

ResourceRegistry

@webda/mcp

Class: ResourceRegistry

Defined in: packages/mcp/src/resources.ts:31

Registry of models exposed as webda://{Model}/{pk...} resources

Constructors​

Constructor​

new ResourceRegistry(filter): ResourceRegistry

Defined in: packages/mcp/src/resources.ts:37

Parameters​

filter​

string[]

model short ids to expose, or ["*"]

Returns​

ResourceRegistry

Properties​

entries​

protected entries: ResourceModel[] = []

Defined in: packages/mcp/src/resources.ts:32

filter​

protected filter: string[]

Defined in: packages/mcp/src/resources.ts:37

model short ids to expose, or ["*"]

Methods​

build()​

build(ops): void

Defined in: packages/mcp/src/resources.ts:44

Rebuild from operations: every visible {Model}.Get with context.pkFields becomes a model; its .Query operation shares the same context.model.

Parameters​

ops​

Record<string, OperationDefinition>

visible operations

Returns​

void

models()​

models(): ResourceModel[]

Defined in: packages/mcp/src/resources.ts:72

Returns​

ResourceModel[]

exposed models, sorted by name

parse()​

parse(uri): { key: Record<string, string>; model: ResourceModel; } | undefined

Defined in: packages/mcp/src/resources.ts:101

Parameters​

uri​

string

a resource URI

Returns​

{ key: Record<string, string>; model: ResourceModel; } | undefined

the model and decoded key, or undefined when it does not match

templates()​

templates(models?): object[]

Defined in: packages/mcp/src/resources.ts:80

Parameters​

models?​

ResourceModel[] = ...

models to describe, all exposed models by default

Returns​

object[]

MCP resource templates

uriFor()​

uriFor(model, record): string

Defined in: packages/mcp/src/resources.ts:93

Parameters​

model​

ResourceModel

the model

record​

Record<string, unknown>

an instance (or key object)

Returns​

string

its resource URI