📋
AB-147

Parameter semantics

📖 Documentation Pillar: Understandability Quick fix Est. cost: $0

What it means

Parameters have descriptions with constraints (min, max, required).

Why it matters

Agents need to know what values are valid for each parameter — type alone is insufficient.

What's wrong

parameters: [{ name: 'limit', in: 'query', schema: { type: 'integer' } }]

What's right

parameters: [{ name: 'limit', in: 'query', description: 'Max results (1-100)', schema: { type: 'integer', minimum: 1, maximum: 100 } }]

Check this rule on your site

Enter your URL to check just this one rule (AB-001).

Related rules in Documentation