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

Codex · Developer

How to Use Vercel documentation search in Codex

Returns matches from Vercel's semantic documentation sitemap. Use it to locate relevant guidance and reference pages before reading the full documentation.

Prompts to try with Vercel documentation search in Codex

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

Use Vercel documentation search to find streaming Functions guidance for the Next.js version in package.json, then identify which documentation pages I should read before changing our chat route.

Vercel documentation searchCodex
Try asking
  • Use Vercel documentation search to look this up and give me the result as a table. Save the result in ./assets.

  • Pull the latest numbers from Vercel documentation search and tell me what changed since last week.

  • Check Vercel documentation search and summarize what you find in three bullet points.

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

How to set up Vercel documentation search in Codex

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

Use Spiral's MCP server

  1. Add the hosted server
    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.

    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.

    npx -y spiral-cli@latest init

Call the Spiral API

  1. Create an API key

    In the console, under API keys.

  2. Run Vercel 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": "vercel-com/developer-documentation/search_docs",
        "input": {
          "q": "<q>"
        }
      }'

Then paste one of the prompts above: Codex finds Vercel documentation search on Spiral, shows the price and runs it.

Vercel documentation search providers and prices

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

AlexandriaDeveloper
Vercel · Search docs
vercel-com/developer-documentation/search_docs

Settings you can ask for

Ask Codex for any of these in your prompt.

SettingAllowed valuesDefaultDescription
Limit1 to 100

Results per call, 1 to 100. Defaults to 10.

Offset0 to 100000

Skip this many matches; pass the previous next_offset (also the continuation).

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

What can you do with Vercel documentation search in Codex?

Turn Vercel's public references into an implementation brief for the application in your repository. A coding agent can connect the published guidance, catalogs, and examples to the project's framework and requirements.

Plan a Next.js AI application

Prepare an architecture brief with documentation, engineering articles, release announcements, model candidates, a starter template, Marketplace services, plan feature boundaries, and documented automation operations.

Research a move to Vercel

Assess a move for an AI application: compare framework guidance and starters, identify replacement integrations and models, check plan features, and locate deployment automation references.

Build an internal Vercel reference library

Organize public guidance, announcements, model references, plan comparisons, integration listings, API references, and starters into a searchable engineering reference with source links.

Design deployment automation

Find documented deployment and domain operations, read their references, and use guides, announcements, and plan feature information to draft an implementation checklist.

Prepare an AI application workshop

Choose a Next.js starter, research its supporting services, shortlist models, and assemble documentation and engineering reading material for participants.

Create a model evaluation shortlist

Find model candidates by documented capabilities, inspect their individual guidance, and collect relevant AI Gateway documentation and announcements before running application-specific evaluations.

Review a starter's production requirements

Research a starter's framework guidance, supporting integrations, plan feature requirements, and documented project operations before adopting it for a business application.

Questions about Vercel documentation search in Codex

Can Codex use Vercel documentation search?

Yes. Add Spiral to Codex as an MCP server, and Codex can find and run Vercel documentation search like any built-in tool.

How much does Vercel documentation search 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 Vercel documentation search in Codex?

No. Spiral runs Vercel 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 Vercel documentation search in Codex?

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

Does Codex wait while Vercel documentation search runs?

Vercel documentation search runs in the background. Codex starts the run, checks on it and gives you the json when it's ready.

Does this data include my deployed application's logs or project settings?

The coverage is limited to public Vercel pages and catalogs. Private project records and runtime logs are outside that boundary.

Are documentation search results the full documentation?

Vercel describes its sitemap as a high-level semantic index and explicitly says it does not replace individual docs. Read the linked page for the full explanation.

What does the documentation's update date mean?

Vercel's Markdown metadata defines the date as the day the source page last changed. That date describes the documentation page.

Do Markdown documentation pages retain code examples and tables?

Yes. Vercel says the Markdown body preserves headings, links, fenced code blocks, and tables.

Does Vercel provide a separate index for product announcements?

Yes. Vercel publishes a dedicated Markdown changelog sitemap, separate from its documentation sitemap.

Get started

Start using Vercel documentation search in Codex

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

Paste this into Codex:

Set up Codex

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