inspector/core/mcp/skillsSchemas.ts
cliffhall bfeebd440d fix: address Copilot review round 2 on #2251
- SkillsScreen: key verdicts and React elements by manifest ROW INDEX,
  not URI. The checker deliberately tolerates a duplicated URI so it can
  report `duplicate-resource`; a URI key collided those rows into one
  verdict, so verifying either updated both and "Verify all" raced two
  different digest/size declarations into the same slot.
- SkillsScreen: hold the invalidation generation in React state keyed by
  the manifest, not a ref bumped during render. `useValueChange` runs its
  callback during render and requires setState-only purity — an abandoned
  render left the ref incremented and silently discarded a live
  verification.
- SkillsScreen: title a size disagreement "Size mismatch" and render its
  reason. `verifySkillResource` catches it before hashing, so the alert
  was showing "actual undefined" under "Digest mismatch".
- SkillsScreen: pass `contents` to ContentViewer so a base64 SKILL.md
  renders. The text-block form substituted "" and painted a blank preview
  for a file verification had just read correctly.
- skills.ts: add `malformed-size` for a size that is not a non-negative
  safe integer, and exclude such values from the 16 MiB total. A negative
  one could pull the sum back under the limit and hide a violation.
- managedSkillsState: make the overlap guard per-session instead of a
  boolean. A disconnect during an in-flight walk left it set, so the
  reconnect's own load no-oped and was never retried — permanently, if
  the stale request never settled. A stale `finally` can no longer clear
  the live session's guard either.
- skillsSchemas: require the `{ skill }` envelope for `skills/get`. The
  accepted SEP settles it, and normalizing an inline entry would let a
  non-conforming response past the one place that could report it.
- #2248 and the PR description: corrected — they said
  `ReadResourceDirectoryResultSchema` was already declared, which round 1
  removed. #2248 now owns defining it, and records the frontmatter
  cross-check gap too.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018kfrH3uRNUM4JAk1reKtyY
Signed-off-by: cliffhall <cliff@futurescale.com>
2026-09-04 21:45:49 -04:00

141 lines
5.9 KiB
TypeScript

/**
* Skills extension wire schemas — SEP-2640 (`io.modelcontextprotocol/skills`).
*
* There is no `@modelcontextprotocol/ext-skills` package (404 on npm) and the
* SDK's era codecs define none of these methods, so the Inspector drives them
* as ordinary `client.request(…, ResultSchema)` calls with the explicit result
* schemas below. That is exactly what the SDK prescribes for a consumer-owned
* extension method: `Protocol._assertOutboundRequestInEra` only fires for names
* one of the era codecs knows, so `skills/list` and `skills/get` are era-blind
* and go out unchanged on both the 2025- and 2026-era legs. The raw-wire escape
* hatch that modern `tasks/*` needs is deliberately NOT used here — `tasks/*`
* are spec names the 2026 codec deleted, which is a different problem.
*
* **This module is the whole wire surface.** SEP-2640 is Accepted, so the method
* names and the entry shape are settled, but the skill *format* is delegated to
* the independently-versioned Agent Skills specification and the SEP leaves the
* `skills/get` caching attributes (SEP-2549 `ttlMs` / `cacheScope`) open. Keeping
* every wire type here makes a spec revision a single-file edit (#2234).
*
* Schemas are deliberately permissive (`looseObject`, and a `digest` typed as a
* plain string rather than a hex-constrained one) so a non-conforming server is
* *surfaced* rather than rejected — the Inspector is a conformance tool, and a
* malformed digest is a finding to report, not a parse error to swallow. The
* structural checks live in `skills.ts`.
*/
import { z } from "zod/v4";
/** SEP-2133 extension identifier for the Skills extension (SEP-2640). */
export const SKILLS_EXTENSION_KEY = "io.modelcontextprotocol/skills";
/** The `skills/list` JSON-RPC method name. */
export const SKILLS_LIST_METHOD = "skills/list";
/** The `skills/get` JSON-RPC method name. */
export const SKILLS_GET_METHOD = "skills/get";
/**
* The `resources/directory/read` method name, gated on the server declaring
* `directoryRead: true` in its extension advertisement. Declared here so the
* one wire-surface module names every method the extension defines, even though
* the Inspector does not call it yet (phase 3 of #2234).
*/
export const RESOURCES_DIRECTORY_READ_METHOD = "resources/directory/read";
/** `mimeType` marking a resource as a directory rather than a file. */
export const DIRECTORY_MIME_TYPE = "inode/directory";
/**
* The literal `resources` value meaning "this skill's file set is generated and
* cannot be enumerated". Integrity verification is impossible for such a skill,
* which is why it is a reported finding rather than a silent absence.
*/
export const DYNAMIC_RESOURCES = "dynamic";
/**
* The verbatim YAML frontmatter of a `SKILL.md`, expressed as JSON. `name` and
* `description` are the two fields SEP-2640 requires; everything else the Agent
* Skills format defines passes through untouched, since that format versions
* independently of this extension.
*/
export const SkillFrontmatterSchema = z.looseObject({
name: z.string().optional(),
description: z.string().optional(),
});
export type SkillFrontmatter = z.infer<typeof SkillFrontmatterSchema>;
/**
* One file in a skill's manifest. `digest` is `sha256:` + 64 lowercase hex per
* the SEP, but it is typed as a bare string so a server that gets the format
* wrong still parses and can be *reported* — see `checkSkillConformance`.
*/
export const SkillResourceSchema = z.looseObject({
uri: z.string(),
digest: z.string().optional(),
size: z.number().optional(),
});
export type SkillResource = z.infer<typeof SkillResourceSchema>;
/**
* A skill entry as returned by `skills/list` and `skills/get`. `resources` is
* either the full file manifest or the literal `"dynamic"`; the union is
* preserved on the type rather than normalized away, because which one a server
* sent is itself the finding.
*/
export const SkillEntrySchema = z.looseObject({
uri: z.string(),
frontmatter: SkillFrontmatterSchema,
resources: z.union([
z.literal(DYNAMIC_RESOURCES),
z.array(SkillResourceSchema),
]),
});
export type SkillEntry = z.infer<typeof SkillEntrySchema>;
/** `skills/list` result: a page of entries plus the opaque cursor. */
export const ListSkillsResultSchema = z.looseObject({
skills: z.array(SkillEntrySchema),
nextCursor: z.string().optional(),
});
export type ListSkillsResult = z.infer<typeof ListSkillsResultSchema>;
/**
* The `skills/get` result envelope: the entry wrapped under `skill`.
*
* Required, not one of two accepted shapes. An earlier revision of this module
* also accepted a bare entry at the top level, on the reading that the SEP
* settled the entry but not its wrapper. It does settle the wrapper, and
* accepting the inline form would silently normalize a non-conforming response
* — which is exactly the failure this extension's support exists to *report*.
* A server that returns the entry inline now fails the parse, loudly.
*/
const GetSkillEnvelopeSchema = z.looseObject({ skill: SkillEntrySchema });
/**
* `skills/get` result, unwrapped to the entry it carries.
*
* The transform means every caller receives a `SkillEntry` and none of them
* reaches into the envelope; the strictness lives in the schema.
*/
export const GetSkillResultSchema = GetSkillEnvelopeSchema.transform(
(result) => result.skill,
);
export type GetSkillResult = SkillEntry;
/**
* ⚠️ **No `resources/directory/read` result schema here yet, on purpose.**
*
* The method name and the directory MIME type above are stated in SEP-2640;
* the shape of the result it returns is not something this PR verified against
* the normative text, and the Inspector does not call the method (phase 3,
* #2248). Declaring a guessed schema would put an unverified claim in the one
* module that is supposed to be the authority on the wire format — and one
* nothing exercises, so it could be wrong indefinitely without failing
* anything. Phase 3 adds it against the spec, alongside the call that uses it.
*/