Interface ResourceLinkSpec

Reference to a server-exposed resource appended to a tool response.

Tool helpers (text(), json(), structured()) accept a links option that emits one resource_link content block per entry. Clients can then call resources/read with the URI to retrieve the full payload without inlining it in the tool result.

interface ResourceLinkSpec {
    annotations?: ContentAnnotations;
    description?: string;
    mimeType?: string;
    name: string;
    title?: string;
    uri: string;
}

Index

Properties

annotations? description? mimeType? name title? uri

Properties

`Optional` `Readonly`annotations

annotations?: ContentAnnotations

Optional content annotations

`Optional` `Readonly`description

description?: string

Optional short description

`Optional` `Readonly`mimeType

mimeType?: string

Optional MIME type of the linked resource

`Readonly`name

name: string

Human-readable resource name

`Optional` `Readonly`title

title?: string

Optional title (display label preferred by clients)

`Readonly`uri

uri: string

Resource URI (must be readable via resources/read)

Interface ResourceLinkSpec

Index

Properties

Properties

`Optional` `Readonly`annotations

`Optional` `Readonly`description

`Optional` `Readonly`mimeType

`Readonly`name

`Optional` `Readonly`title

`Readonly`uri

Settings

On This Page

Interface ResourceLinkSpec

Index

Properties

Properties

Optional Readonlyannotations

Optional Readonlydescription

Optional ReadonlymimeType

Readonlyname

Optional Readonlytitle

Readonlyuri

Settings

On This Page

`Optional` `Readonly`annotations

`Optional` `Readonly`description

`Optional` `Readonly`mimeType

`Readonly`name

`Optional` `Readonly`title

`Readonly`uri