Skip to content

Commit 06c0e08

Browse files
committed
Clarify documentation
1 parent 4e01a6c commit 06c0e08

4 files changed

Lines changed: 46 additions & 38 deletions

File tree

specification/draft/apps.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -463,14 +463,14 @@ interface HostContext {
463463
availableDisplayModes?: string[];
464464
/** Current and maximum dimensions available to the UI. */
465465
viewport?: {
466-
/** Current viewport width in pixels. */
466+
/** Viewport width (if fixed). Only pass width or maxWidth, not both. */
467467
width?: number;
468-
/** Current viewport height in pixels. */
468+
/** Viewport height (if fixed). Only pass height or maxHeight, not both. */
469469
height?: number;
470-
/** Maximum available height in pixels (if constrained). */
471-
maxHeight?: number;
472-
/** Maximum available width in pixels (if constrained). */
470+
/** Maximum available viewport width in pixels (if constrained). */
473471
maxWidth?: number;
472+
/** Maximum available viewport height in pixels (if constrained). */
473+
maxHeight?: number;
474474
};
475475
/** User's language/region preference (BCP 47, e.g., "en-US") */
476476
locale?: string;

src/generated/schema.json

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

src/generated/schema.ts

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

src/spec.types.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -326,14 +326,14 @@ export interface McpUiHostContext {
326326
availableDisplayModes?: string[];
327327
/** @description Current and maximum dimensions available to the UI. */
328328
viewport?: {
329-
/** @description Current viewport width in pixels. */
329+
/** @description Viewport width in pixels (if fixed). Only pass width or maxWidth, not both. */
330330
width?: number;
331-
/** @description Current viewport height in pixels. */
331+
/** @description Viewport height in pixels (if fixed). Only pass height or maxHeight, not both. */
332332
height?: number;
333-
/** @description Maximum available height in pixels (if constrained). */
334-
maxHeight?: number;
335-
/** @description Maximum available width in pixels (if constrained). */
333+
/** @description Maximum available viewport width in pixels (if constrained). Only pass width or maxWidth, not both.*/
336334
maxWidth?: number;
335+
/** @description Maximum available viewport height in pixels (if constrained). Only pass height or maxHeight, not both. */
336+
maxHeight?: number;
337337
};
338338
/** @description User's language and region preference in BCP 47 format. */
339339
locale?: string;

0 commit comments

Comments
 (0)