Function: defineResource()

function defineResource<TContext>(name, config): ResourceBuilder<TContext>;

Defined in: packages/core/src/resource/ResourceBuilder.ts:187

Define a new MCP Resource.

Type Parameters

Type Parameter	Default type
TContext	void

Parameters

Parameter	Type	Description
name	string	Unique resource name (used as identifier)
config	ResourceConfig<TContext>	Resource configuration

Returns

ResourceBuilder<TContext>

A resource builder for registration in ResourceRegistry

Example

const deployStatus = defineResource<AppContext>('deploy_status', {
    uri: 'deploy://status/{environment}',
    description: 'Real-time deploy pipeline status',
    subscribable: true,
    handler: async (uri, ctx) => {
        const env = uri.match(/deploy://status/(.+)/)?.[1];
        const status = await ctx.deployService.getStatus(env);
        return { text: JSON.stringify(status) };
    },
});