← All checks
OpenAPI spec and AI plugin manifest checker
Group D4 pointsrubric r1
We request /openapi.json, /.well-known/openapi.json and /.well-known/ai-plugin.json, and check that the spec has an openapi or swagger field and paths, or that the manifest has an api.url.
Why it matters
An agent can read your docs, but it can only act, such as creating an order or booking a slot, when it knows the endpoints and parameters. A published OpenAPI document gives it that. A file that exists but lacks paths scores 2 of 4, and an HTML page at that URL does not count.
How to fix it
- Export your API as OpenAPI 3 JSON and serve it at
/openapi.json. - Include
"openapi": "3.1.0"and a non-emptypathsobject. - Return
Content-Type: application/json, not your HTML 404 page. - Optionally add
/.well-known/ai-plugin.jsonwith anapi.urlpointing to the spec.
How to verify
Run curl -s https://example.com/openapi.json | jq ".openapi, (.paths | keys | length)".