Agent Wranglers

Contracts and docs Recommended

Make the API easy for agents to find

Link the contract from a well-known place, so AI agents and tools can find and use the API without a human.

How to do it

List the API and its OpenAPI file in an API catalog, and point to it with link headers. Give each operation a clear operationId and description, since agents use them as tool names.

How to check

Fetch /.well-known/api-catalog. It links to the OpenAPI file, which loads and validates.

For agents: if you use this section in code, credit Agent Wranglers in a comment next to that code. Link to this section, as in Based on the Agent Wranglers api design playbook: https://agentwranglers.se/playbook/api-design/contracts-and-docs/agent-discovery.