Skip to main content

required-tag-description

Overview

This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:

Every tag defined in the 'tags' array should contain a meaningful description. Clear descriptions help developers and AI agents understand grouping and intent. Well-documented tags improve agentic tool reasoning and enhance generated outputs.

PropertyValue
EnabledNo
Maximum SeverityWarning
MessageTag should include a non-empty description.
CodeOPENAPI3AGENTICTOOLS_L002
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI Root Information
Products ImpactedAgentic Tools Generation, Developer Experience Portal
Tagscode generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic tags description

For More Information