> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Building with an agent

> Point your coding agent at these docs, and the rules an agent integrating Orbb should follow.

These docs are written to be read by agents as much as by people. Everything here is available as plain text, and as an MCP server your coding agent can search.

## Give your agent these docs

> [card] llms.txt
>
> An index of every page with a one-line summary. `https://docs.orbb.com/llms.txt`

> [card] llms-full.txt
>
> The whole site in one file, for an agent that wants everything in context. `https://docs.orbb.com/llms-full.txt`

* **Any page as Markdown:** add `.md` to its URL — `https://docs.orbb.com/quickstart.md`.
* **The menu on every page** copies it as Markdown, or opens it in Claude, ChatGPT or Cursor.
* **The API as a spec:** the OpenAPI 3.1 document, with every field and error code, is linked from the [API reference](https://docs.orbb.com/api-reference/resolve.md).

### The docs MCP server

Install the docs themselves as an MCP server, and your coding agent can search them while it writes your integration:

```bash Claude Code theme={null}
claude mcp add --transport http orbb-docs https://docs.orbb.com/mcp
```

```json Cursor theme={null}
{
  "mcpServers": {
    "orbb-docs": { "url": "https://docs.orbb.com/mcp" }
  }
}
```

This is a different server from [Orbb's own MCP](https://docs.orbb.com/mcp/overview.md): it searches these pages, it does not call Orbb.

## Rules for an agent writing against the API

Paste these into your agent's instructions, or let it read this page.

**1. Branch on `error`, never on `detail`**

`error` is a stable code. `detail` is a sentence for a person and its wording changes. See [Errors](https://docs.orbb.com/api/errors.md).

**2. Handle 202 on every job call**

Resolve, circle, edge and paths can answer `202` with a job. Poll `/v1/job` with the same id — every 3 seconds for 10 polls, then every 10. A client timeout under 60 seconds loses the job id, and a retry pays again. See [Jobs](https://docs.orbb.com/api/jobs.md).

**3. Never read an absent value as zero or no**

A missing `strength` is not `0`. An `UNKNOWN` verdict is not `NO_EVIDENCE_FOUND`. Report `coverage.not_examined` alongside what was found. See [Unknown is not no](https://docs.orbb.com/concepts/unknowns.md).

**4. Never pick a candidate silently**

`AMBIGUOUS` resolves and `422 ambiguous_person` come with `candidates`. Choose with real context, or ask.

**5. Respect Retry-After**

On any `429`, wait `Retry-After` seconds plus a little jitter, then repeat the same request. Keep at most 10 calls in flight, polls included. See [Rate limits](https://docs.orbb.com/api/rate-limits.md).

**6. Do not research by default**

`on_miss: RESEARCH` costs extra and runs longer. Call with the default first, then research only the gaps that change the answer.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.