🔄
AB-007
Guide and API Consistency
⚡ Actionability
Pillar: Understandability
Moderate effort
Severity: high
Est. cost: $10-50
Gap: semantic
Fix: assisted
What it means
Your agent guide and your API specification describe the same endpoints.
Why it matters
If your guide says one thing but your API does another, agents will fail and avoid your service.
Evidence expected
This rule is verified by:
cross Source: Website content
✗
What's wrong
Guide mentions endpoints that don't exist in the API spec, or vice versa.
✓
What's right
Guide and API spec are perfectly aligned — what agents read is what they get.
Check this rule on your site
Enter your URL to check just this one rule (AB-001).
Related rules in Actionability
Machine-Readable
This rule is also available as JSON: /rules/AB-007.json
Explore More
-
All Rules
Browse the complete rules catalog
-
Agent Guide
Learn how to fix this rule
-
Blog
Related articles on agent readiness