📋
AB-004

API Specification

📖 Documentation Pillar: Understandability Complex implementation Severity: high Est. cost: $100+ Gap: documentation Fix: deterministic

What it means

Your site has a machine-readable API specification that agents can parse.

Why it matters

An API spec is how agents understand what your API does, what parameters it accepts, and what it returns.

Evidence expected

This rule is verified by:

http html Source: Website content
✗

What's wrong

No API specification. Agents can't use your API without guessing.

✓

What's right

A complete API specification tells agents exactly how to use your service.

Check this rule on your site

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

Related rules in Documentation

🧪 Agent Guide Schema Validation
🔌 MCP Server Descriptor
📑 Detailed LLMs File
📌 LLMs File Linked from HTML
📡 RSS or Atom Feed
← Back to all rules

Machine-Readable

This rule is also available as JSON: /rules/AB-004.json

Explore More

  • All Rules

    Browse the complete rules catalog

  • Agent Guide

    Learn how to fix this rule

  • Blog

    Related articles on agent readiness