modelcontextprotocol/ext-apps
Watch
1
0
Fork
You've already forked ext-apps
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Format {@link} tags with monospace display text

Browse source 
Add explicit backtick-wrapped display text to all `{@link}` tags for
monospace rendering in TypeDoc output. This improves readability by:

- Using monospace font for code references (types, methods, functions)
- Stripping module prefixes from display text (e.g., `app!App.connect`
  displays as `App.connect`)

Updated files across the SDK including `App`, `AppBridge`,
`PostMessageTransport`, React hooks, server helpers, types, and
documentation.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Jonathan Hefner 2026-01-22 14:36:45 -06:00
commit 9dd995562a
No known key found for this signature in database
GPG key ID: 0DA40AFD21043691
1 changed files with 217 additions and 217 deletions
Download patch file Download diff file Expand all files Collapse all files

36
src/spec.types.ts
View file

@ -144,7 +144,7 @@ export type McpUiStyles = Record<McpUiStyleVariableKey, string | undefined>;
/**
* @description Request to open an external URL in the host's default browser.
* @see {@link app!App.openLink} for the method that sends this request
* @see {@link app!App.openLink `App.openLink`} for the method that sends this request
*/
export interface McpUiOpenLinkRequest {
method: "ui/open-link";
@ -156,7 +156,7 @@ export interface McpUiOpenLinkRequest {
/**
* @description Result from opening a URL.
* @see {@link McpUiOpenLinkRequest}
* @see {@link McpUiOpenLinkRequest `McpUiOpenLinkRequest`}
*/
export interface McpUiOpenLinkResult {
/** @description True if the host failed to open the URL (e.g., due to security policy). */
@ -170,7 +170,7 @@ export interface McpUiOpenLinkResult {
/**
* @description Request to send a message to the host's chat interface.
* @see {@link app!App.sendMessage} for the method that sends this request
* @see {@link app!App.sendMessage `App.sendMessage`} for the method that sends this request
*/
export interface McpUiMessageRequest {
method: "ui/message";
@ -184,7 +184,7 @@ export interface McpUiMessageRequest {
/**
* @description Result from sending a message.
* @see {@link McpUiMessageRequest}
* @see {@link McpUiMessageRequest `McpUiMessageRequest`}
*/
export interface McpUiMessageResult {
/** @description True if the host rejected or failed to deliver the message. */
@ -227,7 +227,7 @@ export interface McpUiSandboxResourceReadyNotification {
/**
* @description Notification of UI size changes (Guest UI -> Host).
* @see {@link app!App.sendSizeChanged} for the method to send this from Guest UI
* @see {@link app!App.sendSizeChanged `App.sendSizeChanged`} for the method to send this from Guest UI
*/
export interface McpUiSizeChangedNotification {
method: "ui/notifications/size-changed";
@ -287,7 +287,7 @@ export interface McpUiToolCancelledNotification {
* @description CSS blocks that can be injected by apps.
*/
export interface McpUiHostCss {
/** @description CSS for font loading (`@font-face` rules or `@import` statements). Apps must apply using {@link applyHostFonts}. */
/** @description CSS for font loading (`@font-face` rules or `@import` statements). Apps must apply using {@link applyHostFonts `applyHostFonts`}. */
fonts?: string;
}
@ -376,7 +376,7 @@ export interface McpUiHostContext {
/**
* @description Notification that host context has changed (Host -> Guest UI).
* @see {@link McpUiHostContext} for the full context structure
* @see {@link McpUiHostContext `McpUiHostContext`} for the full context structure
*/
export interface McpUiHostContextChangedNotification {
method: "ui/notifications/host-context-changed";
@ -394,7 +394,7 @@ export interface McpUiHostContextChangedNotification {
* The host will typically defer sending the context to the model until the next user message
* (including `ui/message`), and will only send the last update received.
*
* @see {@link app.App.updateModelContext} for the method that sends this request
* @see {@link app.App.updateModelContext `App.updateModelContext`} for the method that sends this request
*/
export interface McpUiUpdateModelContextRequest {
method: "ui/update-model-context";
@ -408,7 +408,7 @@ export interface McpUiUpdateModelContextRequest {
/**
* @description Request for graceful shutdown of the Guest UI (Host -> Guest UI).
* @see {@link app-bridge!AppBridge.teardownResource} for the host method that sends this
* @see {@link app-bridge!AppBridge.teardownResource `AppBridge.teardownResource`} for the host method that sends this
*/
export interface McpUiResourceTeardownRequest {
method: "ui/resource-teardown";
@ -417,7 +417,7 @@ export interface McpUiResourceTeardownRequest {
/**
* @description Result from graceful shutdown request.
* @see {@link McpUiResourceTeardownRequest}
* @see {@link McpUiResourceTeardownRequest `McpUiResourceTeardownRequest`}
*/
export interface McpUiResourceTeardownResult {
/**
@ -443,7 +443,7 @@ export interface McpUiSupportedContentBlockModalities {
/**
* @description Capabilities supported by the host application.
* @see {@link McpUiInitializeResult} for the initialization result that includes these capabilities
* @see {@link McpUiInitializeResult `McpUiInitializeResult`} for the initialization result that includes these capabilities
*/
export interface McpUiHostCapabilities {
/** @description Experimental features (structure TBD). */
@ -476,8 +476,8 @@ export interface McpUiHostCapabilities {
}
/**
* @description Capabilities provided by the Guest UI ({@link app!App}).
* @see {@link McpUiInitializeRequest} for the initialization request that includes these capabilities
* @description Capabilities provided by the Guest UI ({@link app!App `App`}).
* @see {@link McpUiInitializeRequest `McpUiInitializeRequest`} for the initialization request that includes these capabilities
*/
export interface McpUiAppCapabilities {
/** @description Experimental features (structure TBD). */
@ -491,7 +491,7 @@ export interface McpUiAppCapabilities {
/**
* @description Initialization request sent from Guest UI to Host.
* @see {@link app!App.connect} for the method that sends this request
* @see {@link app!App.connect `App.connect`} for the method that sends this request
*/
export interface McpUiInitializeRequest {
method: "ui/initialize";
@ -507,7 +507,7 @@ export interface McpUiInitializeRequest {
/**
* @description Initialization result returned from Host to Guest UI.
* @see {@link McpUiInitializeRequest}
* @see {@link McpUiInitializeRequest `McpUiInitializeRequest`}
*/
export interface McpUiInitializeResult {
/** @description Negotiated protocol version string (e.g., "2025-11-21"). */
@ -527,7 +527,7 @@ export interface McpUiInitializeResult {
/**
* @description Notification that Guest UI has completed initialization (Guest UI -> Host).
* @see {@link app!App.connect} for the method that sends this notification
* @see {@link app!App.connect `App.connect`} for the method that sends this notification
*/
export interface McpUiInitializedNotification {
method: "ui/notifications/initialized";
@ -582,7 +582,7 @@ export interface McpUiResourceMeta {
* @description Request to change the display mode of the UI.
* The host will respond with the actual display mode that was set,
* which may differ from the requested mode if not supported.
* @see {@link app!App.requestDisplayMode} for the method that sends this request
* @see {@link app!App.requestDisplayMode `App.requestDisplayMode`} for the method that sends this request
*/
export interface McpUiRequestDisplayModeRequest {
method: "ui/request-display-mode";
@ -594,7 +594,7 @@ export interface McpUiRequestDisplayModeRequest {
/**
* @description Result from requesting a display mode change.
* @see {@link McpUiRequestDisplayModeRequest}
* @see {@link McpUiRequestDisplayModeRequest `McpUiRequestDisplayModeRequest`}
*/
export interface McpUiRequestDisplayModeResult {
/** @description The display mode that was actually set. May differ from requested if not supported. */