Tools / API catalog checker
API catalog checker
Check whether API-oriented sites publish a catalog that agents can use to discover capabilities, endpoint groups, docs, and action boundaries.
Selected check · PROTO-006-4 pts
What this checks
Well-known catalog
Checks common API catalog paths.
Docs linkage
Looks for public docs entry points.
Capability index
Highlights endpoints and actions agents can reason about.
Machine readability
Prefers JSON or markdown-friendly catalogs.
FAQ
- Who needs an API catalog?
- API-oriented products benefit most. A catalog gives agents a public index of capabilities, endpoint groups, documentation, authentication boundaries, and related machine-readable files.
- Is an API catalog the same as OpenAPI?
- No. OpenAPI describes endpoint behavior. An API catalog can point to OpenAPI, docs, SDKs, changelogs, terms, support, and higher-level capability groups.
- Does the checker call API endpoints?
- No. It looks for public catalog discovery and linking evidence. It does not execute API calls, require keys, or inspect private developer accounts.
- What should the catalog include first?
- Include the public API name, core capability groups, docs links, OpenAPI or Swagger links when available, auth notes, rate-limit or policy links, and support paths.