Skip to content
{mcpdesc}

Shape named example maps and example objects

Named example maps are non-empty, use names matching ^[A-Za-z0-9._-]+$, and hold an example object or a Reference Object. Each example object has its required members, such as input and result, and only its defined properties.

Requirement

Section titled “Requirement”

Example maps and Tool, Resource, Resource Template, Prompt, and completion example objects have valid names, required members, and no unknown properties.

Details

Section titled “Details”

Rule ID: mcpdesc.example.members
Owner: mcpdesc
Surface: Tool, Resource, Resource Template, Prompt, and completion examples
Kind: structural
Requirement level: must
Protocol versions: independent of the MCP protocol version
Document schema locations: #/$defs/toolExamples, #/$defs/toolExample, #/$defs/resourceExamples, #/$defs/resourceExample, #/$defs/resourceTemplateExamples, #/$defs/resourceTemplateExample, #/$defs/promptExamples, #/$defs/promptExample, #/$defs/completionExamples, #/$defs/completionExample, #/$defs/completionArgument, #/$defs/completionContext
Status: internal · Enforcement: internal

Required by

Section titled “Required by”

Examples

Section titled “Examples”

Invalid example

Section titled “Invalid example”

Source: expected-invalid/component-extension-boundaries.json · Selected: /components/toolExamples/x-map-extension

true

Rule Source Code

Section titled “Rule Source Code”

example.yaml at immutable tag v0.9.0-rc.3.