Homepage has agent-useful Link headers

medium

agent_discover_link_headers

Checks if the homepage includes agent-useful Link response headers (RFC 8288).

What does this rule check?

Link response headers allow your site to advertise machine-readable resources — such as API catalogs, documentation, and service descriptors — directly in HTTP responses. AI agents use these headers to discover available APIs and integrations.

Why is this important?

Without Link headers pointing to useful resources, AI agents cannot programmatically discover your APIs, documentation, or service metadata. They must rely on crawling or guesswork, which is unreliable.

How to fix

Add Link response headers to your homepage with agent-useful relation types like api-catalog, service-doc, service-desc, or describedby.

Examples

Incorrect 
HTTP/1.1 200 OK
Content-Type: text/html

<!-- No Link headers at all, or only preload/preconnect links -->
Correct 
HTTP/1.1 200 OK
Content-Type: text/html
Link: </.well-known/api-catalog>; rel="api-catalog"
Link: </docs/api>; rel="service-doc"

Agent fix snippet

Copy this snippet and paste it into your AI coding agent to fix this issue automatically.

Add Link response headers to your homepage:

Link: </.well-known/api-catalog>; rel="api-catalog"
Link: </docs/api>; rel="service-doc"

See RFC 8288 for the Link header format and IANA Link Relations for registered relation types.