Skip to main content

Interface: RegisterAppResourceParams

Defined in: registerAppResource.ts:89

Parameters for registerAppResource.

Properties​

description?​

optional description?: string

Defined in: registerAppResource.ts:97

What the view does and when a host should render it.

html​

html: string | ((args) => string | Promise<string>)

Defined in: registerAppResource.ts:103

The view's HTML5 document, or a builder invoked per resources/read. A builder receives the requested URI so one registration can serve variants of a document.

name​

name: string

Defined in: registerAppResource.ts:93

Resource name, as listed by resources/list.

server​

server: McpServer

Defined in: registerAppResource.ts:91

The McpServer instance to register the app resource on.

ui?​

optional ui?: UiResourceMeta

Defined in: registerAppResource.ts:105

Rendering and security configuration relayed to the host as _meta.ui.

uri​

uri: string

Defined in: registerAppResource.ts:95

Resource URI. Must use the ui:// scheme.