fix(types): forbid csp/permissions on McpUiToolMeta via never#624
Merged
fix(types): forbid csp/permissions on McpUiToolMeta via never#624
Conversation
Hosts read _meta.ui.csp and _meta.ui.permissions from the resource (resources/read content item, with resources/list entry as fallback), never from the tool. Typing them as `never` on McpUiToolMeta gives TypeScript users a compile-time error pointing at McpUiResourceMeta instead of silently accepting and ignoring them. Companion to anthropics/apps#38705 (host-side console.warn). Refs anthropics/claude-ai-mcp#40.
Contributor
PreviewPreview deployments for this PR have been cleaned up. |
@modelcontextprotocol/ext-apps
@modelcontextprotocol/server-basic-preact
@modelcontextprotocol/server-basic-react
@modelcontextprotocol/server-basic-solid
@modelcontextprotocol/server-basic-svelte
@modelcontextprotocol/server-basic-vanillajs
@modelcontextprotocol/server-basic-vue
@modelcontextprotocol/server-budget-allocator
@modelcontextprotocol/server-cohort-heatmap
@modelcontextprotocol/server-customer-segmentation
@modelcontextprotocol/server-debug
@modelcontextprotocol/server-map
@modelcontextprotocol/server-pdf
@modelcontextprotocol/server-scenario-modeler
@modelcontextprotocol/server-shadertoy
@modelcontextprotocol/server-sheet-music
@modelcontextprotocol/server-system-monitor
@modelcontextprotocol/server-threejs
@modelcontextprotocol/server-transcript
@modelcontextprotocol/server-video-resource
@modelcontextprotocol/server-wiki-explorer
commit: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Hosts read
_meta.ui.cspand_meta.ui.permissionsfrom the resource (resources/readcontent item, withresources/listentry as fallback) — never from the tool. Because_meta.ui.resourceUridoes live on the tool, it's an easy mistake to putcspthere too; doing so silently yields the default sandbox CSP.This types
cspandpermissionsas?: neveronMcpUiToolMeta, with JSDoc pointing atMcpUiResourceMeta. Preventive — not tied to a specific bug report.Why
neverand not just rely on excess property checking?For direct object literals — the common
registerAppTool(s, { _meta: { ui: { resourceUri, csp } } })case — TypeScript's excess property check already errors without this change. Theneveradds value in two places:const ui = { resourceUri, csp }; registerAppTool(s, { _meta: { ui } })typechecks clean onmaintoday. Withnever, it fails withType '{...csp...}' is not assignable to 'McpUiToolMeta'.cspdoes not exist in typeMcpUiToolMeta"; theneverfield's hover/docs say where it actually belongs.Generated Zod emits
z.never().optional();McpUiToolMetaSchemais exported but not.parse()'d anywhere in the SDK or host today, so this is dormant at runtime.A companion host-side change adds a
console.warnfor non-TypeScript servers.Test plan
npm run generate:schemas—never→"not": {}in schema.json.bun test— 106/106 pass.main, errors with TS2322 on this branch.