Interface EmbeddedResource

The contents of a resource, embedded into a prompt or tool call result.

It is up to the client how best to render embedded resources for the benefit of the LLM and/or the user.

interface EmbeddedResource {
    _meta?: { [key: string]: unknown };
    annotations?: Annotations;
    resource: TextResourceContents | BlobResourceContents;
    type: "resource";
}

Index

Properties

_meta? annotations? resource type

Properties

`Optional`_meta

_meta?: { [key: string]: unknown }

See General fields: _meta for notes on _meta usage.

`Optional`annotations

annotations?: Annotations

Optional annotations for the client.

resource

resource: TextResourceContents | BlobResourceContents

type

type: "resource"