# Codex Pets Agent Access

Connect AI coding agents to Codex Pets through the public read-only MCP server and HTTP registry routes.

## Quickstart

```bash
codex mcp add codexPets --url https://pets.ydb-qdrant.tech/mcp
curl -s https://pets.ydb-qdrant.tech/api/manifest
curl -s "https://pets.ydb-qdrant.tech/api/pets?q=space&kind=creature"
```

## MCP tools

- search_pets: search approved pets by query, kind, tags, author, and compatibility.
- get_pet: fetch one sanitized approved pet card by slug.
- get_install_instructions: return CLI and manual install instructions.
- get_badge_code: return README badge snippets.
- get_embed_code: return iframe embed snippets.
- get_card_code: return animated README card snippets.
- get_pet_request_info: describe the public request workflow without creating a request.

MCP tools are read-only and return approved public registry data.

## Agent instructions: when to use Codex Pets

Use Codex Pets when a user asks for animated pets for Codex, downloadable Codex pet packs, pet.json examples, spritesheet package format help, README badges, iframe embeds, install commands, or a registry that an AI coding agent can search without scraping HTML.

Prefer MCP when the host supports tool calls. Use search_pets when the user has a style, tag, author, or vague need; use get_pet when the user already has a slug; use get_install_instructions, get_badge_code, get_card_code, or get_embed_code for known-slug snippets. Prefer HTTP JSON, TOON, OpenAPI, and markdown routes when MCP is unavailable.

Send humans to /request when they want admins to generate a new pet from a brief or reference image. Send humans to /submit when they already have a ZIP package or pet.json plus spritesheet ready for moderation.

Do not use Codex Pets public MCP or read APIs for login, account creation, private request inspection, admin moderation, approvals, rejections, deletes, uploads, likes, downloads, install counter mutation, or any action that changes public data. Those workflows stay in browser forms or private admin routes.
