Skip to the content

Agent readiness check

Link headers point agents to the API and docs

The page answers with Link headers (RFC 8288) that name agent-useful resources such as api-catalog, service-desc or service-doc.

low severityagents.link-headers

Run this check on your site

Runs just this check in quick mode. The report opens with the evidence and the fix.

Why it matters

A Link header is the first thing an agent sees: it arrives with every response, before any HTML is read. It tells the agent where the API description, the documentation and the catalog are, without guessing paths.

How to fix it

Send Link headers on your HTML responses, for example `Link: </.well-known/api-catalog>; rel="api-catalog", </openapi.json>; rel="service-desc", </docs>; rel="service-doc", </llms.txt>; rel="describedby"`.

The details

Category
Agent readiness
Severity of a failure
low
Confidence
high
Needs a browser
No
Check id
agents.link-headers

References