Interface ResourceProvider

A ResourceProvider can either:

enumerate concrete resources (list()) — useful for static resources
resolve URIs by pattern (match() + read()) — for dynamic ones (e.g. ifc-lite://model/{id}/entity/{globalId})

Most providers do both: they enumerate the "manifest" resources and serve any URI that matches their patterns.

interface ResourceProvider {
    name: string;
    list(
        ctx: ToolContext,
    ): ResourceDefinition[] | Promise<ResourceDefinition[]>;
    match(uri: string): boolean;
    read(
        uri: string,
        ctx: ToolContext,
    ): ResourceContents[] | Promise<ResourceContents[]>;
}

Index

Properties

Methods

list match read

Properties

name

name: string

Stable name for diagnostics.

Methods

list

list(ctx: ToolContext): ResourceDefinition[] | Promise<ResourceDefinition[]>
Static resources advertised in resources/list.
Parameters
- ctx: ToolContext
Returns ResourceDefinition[] | Promise<ResourceDefinition[]>

match

match(uri: string): boolean
True iff this provider can read the given URI.
Parameters
- uri: string
Returns boolean

read

read(
uri: string,
ctx: ToolContext,
): ResourceContents[] | Promise<ResourceContents[]>
Read the resource. Throws when uri doesn't match.
Parameters
- uri: string
- ctx: ToolContext
Returns ResourceContents[] | Promise<ResourceContents[]>