agent-ready-api-catalog — Claude Code skill: setup and use
agent-ready-api-catalog implements an RFC 9727 API catalog so autonomous agents can discover your endpoints and OpenAPI specifications.
Apache-2.0 ★ 141 updated 2026-10-29
npx skills add fabricioctelles/skills --skill agent-ready-api-catalog -a claude-codeWhat agent-ready-api-catalog does
This skill guides the implementation of /.well-known/api-catalog. The route must return HTTP 200 with application/linkset+json as the content type. Inside, it builds a linkset array containing an anchor URL for each API, coupled with service-desc pointing to the OpenAPI document and service-doc pointing to human-readable docs. You can also include a status relation for health checks.
Validation runs via a POST request to https://isitagentready.com/api/scan. Without returning the exact application/linkset+json header, the automated verification scan fails.
What it helps with
- expose
/.well-known/api-catalogaccording to RFC 9727 - link OpenAPI schemas and documentation inside a JSON linkset
- verify machine discovery status using the isitagentready scan API
Example prompts for the agent
- Implement RFC 9727 api-catalog for this project
- Add
/.well-known/api-catalogroute with links to our OpenAPI schema and docs - Test my API catalog endpoint against the isitagentready.com scanner
How to install agent-ready-api-catalog
1Skills CLI (Vercel)
npx skills add fabricioctelles/skills --skill agent-ready-api-catalog -a claude-code2Manually: put the files in place
~/.claude/skills/api-catalog/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/api-catalog/
1Skills CLI (Vercel)
npx skills add fabricioctelles/skills --skill agent-ready-api-catalog -a codex2Manually: put the files in place
.agents/skills/api-catalog/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add fabricioctelles/skills --skill agent-ready-api-catalog -a cursor2Manually: put the files in place
.cursor/skills/api-catalog/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install fabricioctelles/skills skills/agent-ready-cloudflare/api-catalog2Manually: put the files in place
.github/skills/api-catalog/SKILL.md1Skills CLI (Vercel)
npx skills add fabricioctelles/skills --skill agent-ready-api-catalog -a gemini-cli2Platform CLI
gemini skills install https://github.com/fabricioctelles/skills --path skills/agent-ready-cloudflare/api-catalogManually: put the files in place
.devin/skills/api-catalog/SKILL.mdThe legacy .windsurf/skills/ path still works
Claude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about agent-ready-api-catalog
How to install agent-ready-api-catalog in Claude Code?
Run npx skills add fabricioctelles/skills --skill api-catalog -a claude-code. The file will be placed at ~/.claude/skills/api-catalog/SKILL.md.
What does agent-ready-api-catalog do?
It structures metadata so AI agents can locate your OpenAPI specifications, documentation, and health endpoints through standard discovery paths.
How can I verify the catalog works?
Send a JSON POST request to https://isitagentready.com/api/scan with your site URL and verify that checks.discovery.apiCatalog.status equals pass.
Source text
SKILL.md · Apache-2.0
---
name: agent-ready-api-catalog
description: >
Sub-skill de agent-ready-cloudflare: Implement API Catalog
---
# Implement API Catalog
Publish an API catalog for automated discovery per
[RFC 9727](https://www.rfc-editor.org/rfc/rfc9727).
## Requirements
- Serve `/.well-known/api-catalog` with `Content-Type: application/linkset+json` and HTTP 200
- Include a `linkset` array with entries for each API
- Each entry needs an `anchor` URL and link relations: `service-desc` (OpenAPI spec), `service-doc` (docs), and optionally `status` (health endpoint)
- See [RFC 9727 Appendix A](https://www.rfc-editor.org/rfc/rfc9727#appendix-A) for examples
## Validate
```
POST https://isitagentready.com/api/scan
Content-Type: application/json
{"url": "https://YOUR-SITE.com"}
```
Check that `checks.discovery.apiCatalog.status` is `"pass"`.
© fabricioctelles · Apache-2.0 · fabricioctelles/skills