Document Require Description
document-require-description
info
experience: documentationexperience: data-modeling
spec: servers
description should be present
The description property should be present.
Rule definition
The full Spotlight rule — drop it into a ruleset (.spotlight.yaml / .spectral.yaml) and run it with any Spotlight tool.
document-require-description:
title: Document Require Description
reference: https://spotlight-rules.com/spec/rules/mcp/document-require-description/
description: The `description` property should be present.
message: description should be present
severity: info
given: $
then:
field: description
function: truthy
tags:
- format:mcp
- spec:servers
- experience:documentation
- experience:data-modeling
prompt: "You are editing a MCP document to satisfy the Spotlight API governance
rule 'document-require-description' (Document Require Description).
Requirement: The `description` property should be present. To fix: Ensure
`description` is present and non-empty at each matching location. Make the
smallest change that satisfies the rule, leave all unrelated content, key
order, comments, and formatting unchanged, and keep the document valid MCP.
Return only the complete corrected document, with no commentary."
AI fix prompt — send this to Claude, Gemini, or ChatGPT with your artifact to auto-fix this rule
You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary.
| Artifact | MCP |
|---|---|
| Applies at (given) | $ |
| Severity | info — educational by default; raise to warn/error to enforce |
| Reference | https://spotlight-rules.com/spec/rules/mcp/document-require-description/ |