Skip to content

Documentation / @agentick/mcp / MCPResourceTemplateDefinition

Interface: MCPResourceTemplateDefinition

Defined in: protocol/types.ts:386

A parameterized URI resource (RFC 6570 template).

Properties

complete?

optional complete: Record<string, CompletionHandler>

Defined in: protocol/types.ts:409

Per-variable completion handlers for completion/complete requests targeting this template. Sugar builders from @agentick/mcp/completions are recommended.

Legacy shape (value) => string[] is still accepted for backwards compatibility — coerced to { values: [...] } at dispatch.


description?

optional description: string

Defined in: protocol/types.ts:391


icons?

optional icons: Icon[]

Defined in: protocol/types.ts:394

Optional icons for client UI rendering (IconsSchema).


list()?

optional list: (ctx) => MCPResourceListResult | Promise<MCPResourceListResult>

Defined in: protocol/types.ts:395

Parameters

ctx

MCPHandlerContext

Returns

MCPResourceListResult | Promise<MCPResourceListResult>


mimeType?

optional mimeType: string

Defined in: protocol/types.ts:392


name

name: string

Defined in: protocol/types.ts:387


read()

read: (uri, variables, ctx) => MCPResourceReadResult | Promise<MCPResourceReadResult>

Defined in: protocol/types.ts:396

Parameters

uri

string

variables

Record<string, string>

ctx

MCPHandlerContext

Returns

MCPResourceReadResult | Promise<MCPResourceReadResult>


title?

optional title: string

Defined in: protocol/types.ts:389

Human-readable display name (BaseMetadataSchema). Optional.


uriTemplate

uriTemplate: string

Defined in: protocol/types.ts:390

Released under the ISC License.