Skip to content

Commit 0cc7515

Browse files
committed
docs: add deprecation notice and improve resourceUri documentation
1 parent df11e5e commit 0cc7515

File tree

4 files changed

+16
-7
lines changed

4 files changed

+16
-7
lines changed

src/generated/schema.json

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/generated/schema.ts

Lines changed: 7 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/server/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,10 @@ export interface McpUiAppToolConfig extends ToolConfig {
4848
/**
4949
* URI of the UI resource to display for this tool.
5050
* This is converted to `_meta["ui/resourceUri"]`.
51-
*
51+
*
5252
* @example "ui://weather/widget.html"
53+
*
54+
* @deprecated Use `_meta.ui.resourceUri` instead.
5355
*/
5456
[RESOURCE_URI_META_KEY]?: string;
5557
}

src/spec.types.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -523,7 +523,12 @@ export type McpUiToolVisibility = "model" | "app";
523523
* @description UI-related metadata for tools.
524524
*/
525525
export interface McpUiToolMeta {
526-
/** @description URI of UI resource for rendering tool results. */
526+
/**
527+
* URI of the UI resource to display for this tool.
528+
* This is converted to `_meta["ui/resourceUri"]`.
529+
*
530+
* @example "ui://weather/widget.html"
531+
*/
527532
resourceUri: string;
528533
/**
529534
* @description Who can access this tool. Default: ["model", "app"]

0 commit comments

Comments
 (0)