Format {@link} tags with monospace display text
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
parent
43c30a7665
commit
9dd995562a
1 changed files with 217 additions and 217 deletions
36
src/generated/schema.ts
generated
36
src/generated/schema.ts
generated
|
|
@ -135,7 +135,7 @@ export const McpUiStylesSchema = z
|
|||
|
||||
/**
|
||||
* @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 const McpUiOpenLinkRequestSchema = z.object({
|
||||
method: z.literal("ui/open-link"),
|
||||
|
|
@ -147,7 +147,7 @@ export const McpUiOpenLinkRequestSchema = z.object({
|
|||
|
||||
/**
|
||||
* @description Result from opening a URL.
|
||||
* @see {@link McpUiOpenLinkRequest}
|
||||
* @see {@link McpUiOpenLinkRequest `McpUiOpenLinkRequest`}
|
||||
*/
|
||||
export const McpUiOpenLinkResultSchema = z
|
||||
.object({
|
||||
|
|
@ -163,7 +163,7 @@ export const McpUiOpenLinkResultSchema = z
|
|||
|
||||
/**
|
||||
* @description Result from sending a message.
|
||||
* @see {@link McpUiMessageRequest}
|
||||
* @see {@link McpUiMessageRequest `McpUiMessageRequest`}
|
||||
*/
|
||||
export const McpUiMessageResultSchema = z
|
||||
.object({
|
||||
|
|
@ -247,7 +247,7 @@ export const McpUiResourcePermissionsSchema = z.object({
|
|||
|
||||
/**
|
||||
* @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 const McpUiSizeChangedNotificationSchema = z.object({
|
||||
method: z.literal("ui/notifications/size-changed"),
|
||||
|
|
@ -319,7 +319,7 @@ export const McpUiToolCancelledNotificationSchema = z.object({
|
|||
* @description CSS blocks that can be injected by apps.
|
||||
*/
|
||||
export const McpUiHostCssSchema = z.object({
|
||||
/** @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: z.string().optional(),
|
||||
});
|
||||
|
||||
|
|
@ -339,7 +339,7 @@ export const McpUiHostStylesSchema = z.object({
|
|||
|
||||
/**
|
||||
* @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 const McpUiResourceTeardownRequestSchema = z.object({
|
||||
method: z.literal("ui/resource-teardown"),
|
||||
|
|
@ -348,7 +348,7 @@ export const McpUiResourceTeardownRequestSchema = z.object({
|
|||
|
||||
/**
|
||||
* @description Result from graceful shutdown request.
|
||||
* @see {@link McpUiResourceTeardownRequest}
|
||||
* @see {@link McpUiResourceTeardownRequest `McpUiResourceTeardownRequest`}
|
||||
*/
|
||||
export const McpUiResourceTeardownResultSchema = z.record(
|
||||
z.string(),
|
||||
|
|
@ -387,7 +387,7 @@ export const McpUiSupportedContentBlockModalitiesSchema = z.object({
|
|||
|
||||
/**
|
||||
* @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 const McpUiHostCapabilitiesSchema = z.object({
|
||||
/** @description Experimental features (structure TBD). */
|
||||
|
|
@ -450,8 +450,8 @@ export const McpUiHostCapabilitiesSchema = z.object({
|
|||
});
|
||||
|
||||
/**
|
||||
* @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 const McpUiAppCapabilitiesSchema = z.object({
|
||||
/** @description Experimental features (structure TBD). */
|
||||
|
|
@ -474,7 +474,7 @@ export const McpUiAppCapabilitiesSchema = z.object({
|
|||
|
||||
/**
|
||||
* @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 const McpUiInitializedNotificationSchema = z.object({
|
||||
method: z.literal("ui/notifications/initialized"),
|
||||
|
|
@ -511,7 +511,7 @@ export const McpUiResourceMetaSchema = z.object({
|
|||
* @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 const McpUiRequestDisplayModeRequestSchema = z.object({
|
||||
method: z.literal("ui/request-display-mode"),
|
||||
|
|
@ -523,7 +523,7 @@ export const McpUiRequestDisplayModeRequestSchema = z.object({
|
|||
|
||||
/**
|
||||
* @description Result from requesting a display mode change.
|
||||
* @see {@link McpUiRequestDisplayModeRequest}
|
||||
* @see {@link McpUiRequestDisplayModeRequest `McpUiRequestDisplayModeRequest`}
|
||||
*/
|
||||
export const McpUiRequestDisplayModeResultSchema = z
|
||||
.object({
|
||||
|
|
@ -567,7 +567,7 @@ export const McpUiToolMetaSchema = z.object({
|
|||
|
||||
/**
|
||||
* @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 const McpUiMessageRequestSchema = z.object({
|
||||
method: z.literal("ui/message"),
|
||||
|
|
@ -740,7 +740,7 @@ export const McpUiHostContextSchema = z
|
|||
|
||||
/**
|
||||
* @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 const McpUiHostContextChangedNotificationSchema = z.object({
|
||||
method: z.literal("ui/notifications/host-context-changed"),
|
||||
|
|
@ -760,7 +760,7 @@ export const McpUiHostContextChangedNotificationSchema = z.object({
|
|||
* 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 const McpUiUpdateModelContextRequestSchema = z.object({
|
||||
method: z.literal("ui/update-model-context"),
|
||||
|
|
@ -785,7 +785,7 @@ export const McpUiUpdateModelContextRequestSchema = z.object({
|
|||
|
||||
/**
|
||||
* @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 const McpUiInitializeRequestSchema = z.object({
|
||||
method: z.literal("ui/initialize"),
|
||||
|
|
@ -805,7 +805,7 @@ export const McpUiInitializeRequestSchema = z.object({
|
|||
|
||||
/**
|
||||
* @description Initialization result returned from Host to Guest UI.
|
||||
* @see {@link McpUiInitializeRequest}
|
||||
* @see {@link McpUiInitializeRequest `McpUiInitializeRequest`}
|
||||
*/
|
||||
export const McpUiInitializeResultSchema = z
|
||||
.object({
|
||||
|
|
|
|||
Loading…
Reference in a new issue