required-parameter-description
Overview
This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:
Parameter descriptions help both developers and AI agents understand the purpose, expected format, and constraints of inputs. Provide a meaningful description for every parameter.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Error |
| Message | Parameter must include a non-empty description. |
| Code | OPENAPI3AGENTICTOOLS_L330 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Parameters |
| Products Impacted | Agentic Tools Generation, Developer Experience Portal |
| Tags | code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic parameter description |
Suggested Fixes
- Add a description to the parameter object.
- Avoid empty or null descriptions.