Interface: ResourceBuilder<TContext>

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

Public interface for a resource builder.

Consumed by ResourceRegistry for registration and routing.

Type Parameters

Type Parameter	Default type
TContext	void

Methods

buildResourceDefinition()

buildResourceDefinition(): McpResourceDef;

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

Build the MCP resource definition for resources/list

Returns

McpResourceDef

---

getName()

getName(): string;

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

Get the resource name (unique identifier)

Returns

string

---

getTags()

getTags(): string[];

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

Get optional tags for filtering

Returns

string[]

---

getUri()

getUri(): string;

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

Get the URI or URI template

Returns

string

---

isSubscribable()

isSubscribable(): boolean;

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

Whether this resource supports subscriptions

Returns

boolean

---

read()

read(uri, ctx): Promise<ResourceContent>;

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

Read the resource content for a given URI

Parameters

Parameter	Type
uri	string
ctx	TContext

Returns

Promise<ResourceContent>