[Integrations](https://spiral.ai/integrations) › [Codex](https://spiral.ai/integrations/codex) › [Read the Docs page index](https://spiral.ai/integrations/codex/read-the-docs-page-index)

# How to Use Read the Docs page index in Codex

Returns the Sphinx or MkDocs page index for a documentation version. Use it to map available pages and choose what to read without relying on a topic search.

|  |  |
| --- | --- |
| Model | Read the Docs page index |
| Available through | Alexandria |
| Category | Developer |
| Price | $0.00873 per call. |
| Returns | json |
| Runs | In the background |
| Setup | About 2 minutes, no API key |

## Prompts to try with Read the Docs page index in Codex

- Use Read the Docs page index for pypdf's stable documentation to identify pages worth consulting before changing this repository's PDF extraction code.
- Use Read the Docs page index to look this up and give me the result as a table. Save the result in ./assets.
- Pull the latest numbers from Read the Docs page index and tell me what changed since last week.
- Check Read the Docs page index and summarize what you find in three bullet points.
- Pull the newest data from Read the Docs page index and give me the result as a table.

## How to set up Read the Docs page index in Codex

Pick the way that suits you. Each takes about two minutes.

### Use Spiral's MCP server

1. **Add the hosted server**

```bash
codex mcp add spiral --url https://api.spiral.ai/mcp
```

2. **Sign in**: Codex opens the browser: sign in to Spiral and click Authorize. No API key. `codex mcp list` then shows Spiral.

```bash
codex mcp login spiral
```

### Use the Spiral skill

1. **Send Codex this message**: Your agent reads Spiral's skill and sets itself up.

```
set up https://spiral.ai/SKILL.md
```

2. **Sign in or paste a key**: Approve Spiral in the browser, or give the agent a key from the console.

### Use the Spiral CLI

1. **Install and sign in**: Installs the Spiral CLI, signs you in and adds its skill to your coding agents.

```bash
npx -y spiral-cli@latest init
```

### Call the Spiral API

1. **Create an API key**: In the console, under API keys.

2. **Run Read the Docs page index**: One request; the result comes back by polling or a webhook.

```bash
curl https://api.spiral.ai/v1/runs \
  -H "Authorization: Bearer $SPIRAL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "provider": "alexandria",
    "model": "readthedocs-io/developer-documentation/list_pages",
    "input": {
      "project": "<project>"
    }
  }'
```

Then paste one of the prompts above: Codex finds Read the Docs page index on Spiral, shows the price and runs it.

Setup guide in the docs: https://spiral.ai/docs/quickstarts/codex

## Read the Docs page index tools and prices

- [Read the Docs · List pages](https://spiral.ai/tools/alexandria/readthedocs-io/developer-documentation/list_pages) (Alexandria): $0.00873 per call.

## Settings you can ask for

| Setting | Allowed values | Default | Description |
| --- | --- | --- | --- |
| q |  | — | Case-insensitive substring filter on page title or path. |
| url |  | — | Alternatively any page URL on https://<project>.readthedocs.io/; the project (and, where the function uses it, the version) is read from it. Exactly one of project or url. Pattern: ^[Hh][Tt][Tt][Pp][Ss]?://. |
| limit | 1 to 1000 | — | Pages to return (default 200). |
| offset | 0 to 100000 | — | Pages to skip; pass next_offset to continue. |
| project |  | — | Read the Docs project slug, the <project> in https://<project>.readthedocs.io (e.g. pillow, argo-cd, pypdf, pymupdf). Pattern: ^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$. |
| version |  | — | Version slug as it appears in the docs URL (latest, stable, a branch or tag slug such as release-3.6 or 6.1.0). Defaults to the project's default version. Pattern: ^[A-Za-z0-9._-]{1,100}$. |

## What can you do with Read the Docs page index in Codex?

Prepare a Pillow or pypdf code change using documentation matched to the project's dependency version. Combine Read the Docs project details, page indexes, search hits, and page text to support the implementation.

### Prepare a dependency upgrade

For a Pillow upgrade, identify published documentation versions, inventory relevant reference pages, locate affected APIs, and read the instructions needed for a migration checklist.

### Answer a technical support question

Investigate a pypdf text extraction question by checking the documentation versions, browsing available guides, finding relevant sections, and reading the supporting pages before drafting an answer.

### Build a documentation reading plan

Create an Argo CD reading plan from published versions, available guide pages, topic search results, and selected page content. Organize it around the team's deployment questions.

### Draft an operations runbook

Check Argo CD's published documentation versions, map operational guides, find sync-related sections, and read their instructions to draft a runbook with supporting documentation links.

### Review documentation changes

Compare repeated checks of pypdf's published versions, page inventory, topic search results, and selected page text. Report newly available documentation separately from changes to existing instructions.

### Evaluate a library against requirements

Assess Pillow for an image processing task by reviewing its published documentation versions, mapping reference pages, locating required operations, and reading the documented behavior before recommending an implementation.

## Overview

- [Alexandria](https://spiral.ai/providers/alexandria)
- [All Codex guides](https://spiral.ai/integrations/codex)

## Read the Docs page index in other agents

- [Amp](https://spiral.ai/integrations/amp/read-the-docs-page-index)
- [ChatGPT](https://spiral.ai/integrations/chatgpt/read-the-docs-page-index)
- [Claude](https://spiral.ai/integrations/claude-desktop/read-the-docs-page-index)
- [Claude Code](https://spiral.ai/integrations/claude-code/read-the-docs-page-index)
- [Cline](https://spiral.ai/integrations/cline/read-the-docs-page-index)
- [Cursor](https://spiral.ai/integrations/cursor/read-the-docs-page-index)
- [Devin](https://spiral.ai/integrations/devin/read-the-docs-page-index)
- [dots](https://spiral.ai/integrations/dots/read-the-docs-page-index)
- [Factory Droid](https://spiral.ai/integrations/factory-droid/read-the-docs-page-index)
- [Gemini](https://spiral.ai/integrations/gemini/read-the-docs-page-index)
- [Gemini CLI](https://spiral.ai/integrations/gemini-cli/read-the-docs-page-index)
- [Google Antigravity](https://spiral.ai/integrations/antigravity/read-the-docs-page-index)
- [goose](https://spiral.ai/integrations/goose/read-the-docs-page-index)
- [Grok](https://spiral.ai/integrations/grok/read-the-docs-page-index)
- [Grok Build](https://spiral.ai/integrations/grok-build/read-the-docs-page-index)
- [Hermes](https://spiral.ai/integrations/hermes/read-the-docs-page-index)
- [Instinct](https://spiral.ai/integrations/instinct/read-the-docs-page-index)
- [Manus](https://spiral.ai/integrations/manus/read-the-docs-page-index)
- [Muse](https://spiral.ai/integrations/muse/read-the-docs-page-index)
- [Muse Code](https://spiral.ai/integrations/muse-code/read-the-docs-page-index)
- [n8n](https://spiral.ai/integrations/n8n/read-the-docs-page-index)
- [Notion](https://spiral.ai/integrations/notion/read-the-docs-page-index)
- [OpenClaw](https://spiral.ai/integrations/openclaw/read-the-docs-page-index)
- [opencode](https://spiral.ai/integrations/opencode/read-the-docs-page-index)
- [Perplexity](https://spiral.ai/integrations/perplexity/read-the-docs-page-index)
- [Raycast](https://spiral.ai/integrations/raycast/read-the-docs-page-index)
- [VS Code](https://spiral.ai/integrations/vscode/read-the-docs-page-index)
- [Windsurf](https://spiral.ai/integrations/windsurf/read-the-docs-page-index)
- [Zapier](https://spiral.ai/integrations/zapier/read-the-docs-page-index)

## More Codex guides

- [Read the Docs documentation search](https://spiral.ai/integrations/codex/read-the-docs-documentation-search)
- [Read the Docs project details](https://spiral.ai/integrations/codex/read-the-docs-project-details)
- [Read the Docs documentation page](https://spiral.ai/integrations/codex/read-the-docs-documentation-page)
- [Red Hat CVE details](https://spiral.ai/integrations/codex/red-hat-cve-details)
- [Railway template category](https://spiral.ai/integrations/codex/railway-template-category)
- [Red Hat CVE search](https://spiral.ai/integrations/codex/red-hat-cve-search)

## Questions about Read the Docs page index in Codex

**Can Codex use Read the Docs page index?**

Yes. Add Spiral to Codex as an MCP server, and Codex can find and run Read the Docs page index like any built-in tool.

**How much does Read the Docs page index cost in Codex?**

$0.00873 per call. You pay from your Spiral balance as you go, with no subscription, and a failed run is not charged. Your Codex plan is separate.

**Do I need an Alexandria account to use Read the Docs page index in Codex?**

No. Spiral runs Read the Docs page index on its own Alexandria account. You sign in to Spiral once and never paste a key.

**How long does it take to set up Read the Docs page index in Codex?**

About two minutes: add the hosted server, then sign in.

**Does Codex wait while Read the Docs page index runs?**

Read the Docs page index runs in the background. Codex starts the run, checks on it and gives you the json when it's ready.

**Does latest mean the latest released software?**

No. Read the Docs says the latest documentation can include features that have not been deployed. Choose documentation that matches the software release you need.

**When does documentation become searchable?**

For Sphinx documentation, Read the Docs indexes documents after a successful build. Search freshness therefore depends on the project's successful documentation builds.

**How much historical documentation is available?**

Availability depends on which versions the project keeps active. Read the Docs deletes documentation content for inactive versions, so a repository's old tags do not guarantee readable historical docs.

**Can a project be missing from documentation search?**

Yes. In February 2026, Read the Docs reported removing projects with no builds or searches in the preceding 90 days from its search index. A missing search result alone does not establish that the documentation page is gone.

**How many results does Read the Docs search return by default?**

Read the Docs reported reducing its upstream default to 15 results in February 2026. That source default does not establish how many results the gateway endpoint returns.

