required-operation-summary
Overview
This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:
Agentic tools heavily rely on operation summaries to understand API intent. Ensure every operation object includes a concise, meaningful summary to improve AI reasoning and tool output quality.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Error |
| Message | Operation must have a summary. |
| Code | OPENAPI3AGENTICTOOLS_L230 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Operations |
| Products Impacted | Agentic Tools Generation, Developer Experience Portal |
| Tags | code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic operation summary |
Suggested Fixes
- Add a clear, non-empty summary to each operation.
- Avoid vague or placeholder text.