Spiral gives your agent every tool with one account. Browse the tools →

VS Code · Developer

How to Use Read the Docs documentation search in VS Code

Returns documentation search hits divided into sections with matching text highlighted. Use it to locate a topic before reading the full reference or guide.

Prompts to try with Read the Docs documentation search in VS Code

Copy an example into VS Code, or ask in your own words.

Use Read the Docs documentation search to locate pypdf guidance on encrypted PDFs, then identify which results are relevant to this project's PDF reader.

Read the Docs documentation searchVS Code
Try asking
  • Use Read the Docs documentation search 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 documentation search and tell me what changed since last week.

  • Check Read the Docs documentation search and summarize what you find in three bullet points.

  • Pull the newest data from Read the Docs documentation search and give me the result as a table.

How to set up Read the Docs documentation search in VS Code

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

Use Spiral's MCP server

  1. Add the hosted server

    Use Add to VS Code on the console's Agents & MCP page, or run:

    code --add-mcp '{"name":"spiral","type":"http","url":"https://api.spiral.ai/mcp"}'
  2. Sign in

    VS Code asks you to sign in when it first starts the server: sign in to Spiral and click Authorize. No API key. Run MCP: List Servers from the Command Palette to check that Spiral is running.

Use the Spiral skill

  1. Send VS Code 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.

    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 documentation search

    One request; the result comes back by polling or a webhook.

    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/search_docs",
        "input": {
          "query": "<query>",
          "project": "<project>"
        }
      }'

Then paste one of the prompts above: VS Code finds Read the Docs documentation search on Spiral, shows the price and runs it.

Read the Docs documentation search providers and prices

Spiral runs Read the Docs documentation search through Alexandria. Open a card for today's price, with every fee included.

AlexandriaDeveloper
Read the Docs · Search docs
readthedocs-io/developer-documentation/search_docs

Settings you can ask for

Ask VS Code for any of these in your prompt.

SettingAllowed valuesDefaultDescription
Page1 to 100

Result page, 1-based; pass next_page to continue.

Every API field of Read the Docs · Search docs is on its tool page: open its card above.

What can you do with Read the Docs documentation search in VS Code?

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.

Questions about Read the Docs documentation search in VS Code

Can VS Code use Read the Docs documentation search?

Yes. Add Spiral to VS Code as an MCP server, and VS Code can find and run Read the Docs documentation search like any built-in tool.

How much does Read the Docs documentation search cost in VS Code?

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

Do I need an Alexandria account to use Read the Docs documentation search in VS Code?

No. Spiral runs Read the Docs documentation search 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 documentation search in VS Code?

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

Does VS Code wait while Read the Docs documentation search runs?

Read the Docs documentation search runs in the background. VS Code 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.

Get started

Start using Read the Docs documentation search in VS Code

One Spiral account for every tool your agent needs. No subscription; you pay per run.

Paste this into VS Code:

Set up VS Code

set up https://spiral.ai/SKILL.md
Are you an AI agent? See setup options