LLMs & Coding Agents
BiomAPI exposes several machine-readable resources designed for LLMs and coding agents building integrations.
OpenAPI spec
Section titled “OpenAPI spec”FastAPI auto-generates a full OpenAPI 3.0 spec at:
GET /openapi.jsonThis is the canonical machine-readable description of every endpoint, request/response schema, authentication scheme, and error code. Feed it to any LLM or agent that needs to understand the API before writing code against it.
The interactive Swagger UI is built from the same spec.
llms.txt — site index for LLMs
Section titled “llms.txt — site index for LLMs”Three variants of the documentation site index are available at the root:
| URL | Contents |
|---|---|
/llms.txt | Short index — page titles and descriptions |
/llms-full.txt | Full page content in plain text |
/llms-small.txt | Condensed version optimized for smaller context windows |
These follow the llms.txt convention and are auto-generated from the documentation source by the Starlight build. Use them to give an LLM a fast overview of what BiomAPI does and how to use it without browsing individual pages.
CLI as an agent skill
Section titled “CLI as an agent skill”The BiomAPI CLI (biomapi.py) is distributed as an Agent Skill — a structured plugin that Claude Code and Codex CLI can install and invoke directly in conversation.
Claude Code
Section titled “Claude Code”/plugin marketplace add mglraimundo/biomapi-cli/plugin install biomapi-cli@mglraimundo-biomapi-cliOnce installed, the agent can call biomapi process, biomapi retrieve, biomapi csv, and other commands without leaving the conversation.
Codex CLI
Section titled “Codex CLI”cp -r skills/biomapi ~/.codex/skills/What the skill provides
Section titled “What the skill provides”The skill bundles:
biomapi.py— zero-dependency Python script (only stdlib; no pip)SKILL.md— agent-readable capability description and invocation guidereference.md— API reference formatted for agent context
Source: mglraimundo/biomapi-cli