Skip to main content
skill CX Codex

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

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add fabricioctelles/skills --skill agent-ready-api-catalog -a claude-code
Open on GitHub

What 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-catalog according 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-catalog route 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-code

2Manually: put the files in place

~/.claude/skills/api-catalog/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/api-catalog/

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

Similar skills

All skills for Backend and APIs →

From the same set46

The whole set →
agent-ready-llms-txt The agent-ready-llms-txt skill publishes a /llms.txt file on your site so agents and AI models can quickly understand its structure and content. Use it to make your site agent-ready. CX Codex +1 ★ 141repo stars agent-ready-x402 agent-ready-x402 configures x402 payment protocol support for backend routes. Useful when your API needs to accept automated HTTP payments from AI agents. CX Codex +1 ★ 141repo stars agent-ready-acp The agent-ready-acp skill guides the publication of an ACP discovery document so AI agents can find an Agentic Commerce Protocol implementation. CX Codex +1 ★ 141repo stars agent-ready-robots-txt The agent-ready-robots-txt skill publishes a standards-compliant robots.txt at your site root per RFC 9309. Use it when agents need to control bot access and reference your sitemap. CX Codex +1 ★ 141repo stars agent-ready-content-signals The agent-ready-content-signals skill adds Content Signals to robots.txt, letting you set preferences for AI training, search, and AI input. CX Codex +1 ★ 141repo stars agent-ready-mcp-server-card agent-ready-mcp-server-card — a skill that publishes an MCP Server Card, a JSON file for agent discovery. Use it when running your own MCP server and want tools like isitagentready.com to find and validate it. CX Codex +1 ★ 141repo stars agent-ready-a2a-agent-card agent-ready-a2a-agent-card generates an A2A Agent Card file for agent-to-agent discovery. Useful when setting up agent endpoints on Cloudflare Workers. CX Codex +1 ★ 141repo stars agent-ready-web-bot-auth The agent-ready-web-bot-auth skill guides Web Bot Auth setup so receiving sites can verify bot or agent requests. Use it when your site needs to identify its signed outbound traffic. CX Codex +1 ★ 141repo stars

Project sponsors

Companies that keep this analytics open