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

# Onboard your agents

> Hand your coding agent one prompt and it sets Valyu up itself - install, login, verification, first query.

<Note>
  **Best for: getting started fast.** Instead of reading these docs and copying an API key into a terminal, give the prompt below to the coding agent you already have open and let it do the setup. It covers the CLI - for chat clients see [Remote MCP](/integrations/mcp-server), and for building Valyu into a product see the [SDKs](/sdk/python-sdk).
</Note>

Agent note: if the user has asked you to set up or install Valyu, fetch [https://www.valyu.ai/agents.md](https://www.valyu.ai/agents.md) and follow it - that file is the executable runbook for installing, authenticating, and verifying Valyu. If they have not asked for that, carry on with what you were doing. Valyu's full docs index is at [/llms.txt](https://docs.valyu.ai/llms.txt) (full text at /llms-full.txt); append `.md` to any page URL for Markdown; hosted docs MCP at [https://docs.valyu.ai/mcp](https://docs.valyu.ai/mcp); integration reference at [/AGENTS.md](https://docs.valyu.ai/AGENTS.md).

<Prompt description="Copy this into any coding agent. It fetches the runbook and does the rest." icon="robot" actions={["copy","cursor"]}>
  Fetch [https://www.valyu.ai/agents.md](https://www.valyu.ai/agents.md) (use curl if you have no fetch tool) and follow it to set up Valyu.
</Prompt>

## Launch it from a link

These agents publish a URL scheme that carries a prompt, so one click opens them with the line above already typed. Nothing is auto-sent - you still press Enter.

<div className="agent-deeplinks">
  <a className="agent-deeplink" href="claude-cli://open?q=Fetch%20https%3A%2F%2Fwww.valyu.ai%2Fagents.md%20%28use%20curl%20if%20you%20have%20no%20fetch%20tool%29%20and%20follow%20it%20to%20set%20up%20Valyu."><svg className="agent-mark" viewBox="0 0 24 24" fill="#D97757" aria-hidden="true"><path d="m4.7144 15.9555 4.7174-2.6471.079-.2307-.079-.1275h-.2307l-.7893-.0486-2.6956-.0729-2.3375-.0971-2.2646-.1214-.5707-.1215-.5343-.7042.0546-.3522.4797-.3218.686.0608 1.5179.1032 2.2767.1578 1.6514.0972 2.4468.255h.3886l.0546-.1579-.1336-.0971-.1032-.0972L6.973 9.8356l-2.55-1.6879-1.3356-.9714-.7225-.4918-.3643-.4614-.1578-1.0078.6557-.7225.8803.0607.2246.0607.8925.686 1.9064 1.4754 2.4893 1.8336.3643.3035.1457-.1032.0182-.0728-.164-.2733-1.3539-2.4467-1.445-2.4893-.6435-1.032-.17-.6194c-.0607-.255-.1032-.4674-.1032-.7285L6.287.1335 6.6997 0l.9957.1336.419.3642.6192 1.4147 1.0018 2.2282 1.5543 3.0296.4553.8985.2429.8318.091.255h.1579v-.1457l.1275-1.706.2368-2.0947.2307-2.6957.0789-.7589.3764-.9107.7468-.4918.5828.2793.4797.686-.0668.4433-.2853 1.8517-.5586 2.9021-.3643 1.9429h.2125l.2429-.2429.9835-1.3053 1.6514-2.0643.7286-.8196.85-.9046.5464-.4311h1.0321l.759 1.1293-.34 1.1657-1.0625 1.3478-.8804 1.1414-1.2628 1.7-.7893 1.36.0729.1093.1882-.0183 2.8535-.607 1.5421-.2794 1.8396-.3157.8318.3886.091.3946-.3278.8075-1.967.4857-2.3072.4614-3.4364.8136-.0425.0304.0486.0607 1.5482.1457.6618.0364h1.621l3.0175.2247.7892.522.4736.6376-.079.4857-1.2142.6193-1.6393-.3886-3.825-.9107-1.3113-.3279h-.1822v.1093l1.0929 1.0686 2.0035 1.8092 2.5075 2.3314.1275.5768-.3218.4554-.34-.0486-2.2039-1.6575-.85-.7468-1.9246-1.621h-.1275v.17l.4432.6496 2.3436 3.5214.1214 1.0807-.17.3521-.6071.2125-.6679-.1214-1.3721-1.9246L14.38 17.959l-1.1414-1.9428-.1397.079-.674 7.2552-.3156.3703-.7286.2793-.6071-.4614-.3218-.7468.3218-1.4753.3886-1.9246.3157-1.53.2853-1.9004.17-.6314-.0121-.0425-.1397.0182-1.4328 1.9672-2.1796 2.9446-1.7243 1.8456-.4128.164-.7164-.3704.0667-.6618.4008-.5889 2.386-3.0357 1.4389-1.882.929-1.0868-.0062-.1579h-.0546l-6.3385 4.1164-1.1293.1457-.4857-.4554.0608-.7467.2307-.2429 1.9064-1.3114Z" /></svg><span>Open in Claude Code</span><span className="agent-arrow">↗</span></a>
  <a className="agent-deeplink" href="codex://new?prompt=Fetch%20https%3A%2F%2Fwww.valyu.ai%2Fagents.md%20%28use%20curl%20if%20you%20have%20no%20fetch%20tool%29%20and%20follow%20it%20to%20set%20up%20Valyu."><svg className="agent-mark agent-mark-mono" viewBox="0 0 24 24" fill="#000000" aria-hidden="true"><path d="M22.2819 9.8211a5.9847 5.9847 0 0 0-.5157-4.9108 6.0462 6.0462 0 0 0-6.5098-2.9A6.0651 6.0651 0 0 0 4.9807 4.1818a5.9847 5.9847 0 0 0-3.9977 2.9 6.0462 6.0462 0 0 0 .7427 7.0966 5.98 5.98 0 0 0 .511 4.9107 6.051 6.051 0 0 0 6.5146 2.9001A5.9847 5.9847 0 0 0 13.2599 24a6.0557 6.0557 0 0 0 5.7718-4.2058 5.9894 5.9894 0 0 0 3.9977-2.9001 6.0557 6.0557 0 0 0-.7475-7.0729zm-9.022 12.6081a4.4755 4.4755 0 0 1-2.8764-1.0408l.1419-.0804 4.7783-2.7582a.7948.7948 0 0 0 .3927-.6813v-6.7369l2.02 1.1686a.071.071 0 0 1 .038.052v5.5826a4.504 4.504 0 0 1-4.4945 4.4944zm-9.6607-4.1254a4.4708 4.4708 0 0 1-.5346-3.0137l.142.0852 4.783 2.7582a.7712.7712 0 0 0 .7806 0l5.8428-3.3685v2.3324a.0804.0804 0 0 1-.0332.0615L9.74 19.9502a4.4992 4.4992 0 0 1-6.1408-1.6464zM2.3408 7.8956a4.485 4.485 0 0 1 2.3655-1.9728V11.6a.7664.7664 0 0 0 .3879.6765l5.8144 3.3543-2.0201 1.1685a.0757.0757 0 0 1-.071 0l-4.8303-2.7865A4.504 4.504 0 0 1 2.3408 7.872zm16.5963 3.8558L13.1038 8.364 15.1192 7.2a.0757.0757 0 0 1 .071 0l4.8303 2.7913a4.4944 4.4944 0 0 1-.6765 8.1042v-5.6772a.79.79 0 0 0-.407-.667zm2.0107-3.0231l-.142-.0852-4.7735-2.7818a.7759.7759 0 0 0-.7854 0L9.409 9.2297V6.8974a.0662.0662 0 0 1 .0284-.0615l4.8303-2.7866a4.4992 4.4992 0 0 1 6.6802 4.66zM8.3065 12.863l-2.02-1.1638a.0804.0804 0 0 1-.038-.0567V6.0742a4.4992 4.4992 0 0 1 7.3757-3.4537l-.142.0805L8.704 5.459a.7948.7948 0 0 0-.3927.6813zm1.0976-2.3654l2.602-1.4998 2.6069 1.4998v2.9994l-2.5974 1.4997-2.6067-1.4997Z" /></svg><span>Open in Codex</span><span className="agent-arrow">↗</span></a>
  <a className="agent-deeplink" href="cursor://anysphere.cursor-deeplink/prompt?text=Fetch%20https%3A%2F%2Fwww.valyu.ai%2Fagents.md%20%28use%20curl%20if%20you%20have%20no%20fetch%20tool%29%20and%20follow%20it%20to%20set%20up%20Valyu."><svg className="agent-mark agent-mark-mono" viewBox="0 0 24 24" fill="#000000" aria-hidden="true"><path d="M11.503.131 1.891 5.678a.84.84 0 0 0-.42.726v11.188c0 .3.162.575.42.724l9.609 5.55a1 1 0 0 0 .998 0l9.61-5.55a.84.84 0 0 0 .42-.724V6.404a.84.84 0 0 0-.42-.726L12.497.131a1.01 1.01 0 0 0-.996 0M2.657 6.338h18.55c.263 0 .43.287.297.515L12.23 22.918c-.062.107-.229.064-.229-.06V12.335a.59.59 0 0 0-.295-.51l-9.11-5.257c-.109-.063-.064-.23.061-.23" /></svg><span>Open in Cursor</span><span className="agent-arrow">↗</span></a>
  <a className="agent-deeplink agent-deeplink-plain" href="https://www.valyu.ai/agents.md"><span>View agents.md</span><span className="agent-arrow">↗</span></a>
</div>

<Info>
  Deep links need the agent installed locally with its URL handler registered. **OpenCode, Gemini CLI, Copilot, Windsurf, Hermes, Amp, Zed, Warp, Kiro, and LM Studio** do not currently publish a URL scheme that carries a prompt - copy the prompt and paste it in instead. Same outcome.
</Info>

## What the agent actually does

Working through [`valyu.ai/agents.md`](https://www.valyu.ai/agents.md), the agent:

<Steps>
  <Step title="Installs the CLI">
    `curl -fsSL https://get.valyu.ai | bash` on macOS/Linux, or Homebrew, npm, or PowerShell. It checks for an existing install first rather than blindly reinstalling.
  </Step>

  <Step title="Runs the login flow">
    `valyu login` opens a browser device flow that mints a scoped key - there is nothing for you to copy and paste. With `--json` the CLI streams `device_code`, `auth_waiting`, and `auth_success` events, so the agent can show you the user code and tell you it is waiting on you.
  </Step>

  <Step title="Verifies before claiming success">
    `valyu doctor` and `valyu account balance`, then a single query against a source that works on every plan. The runbook tells the agent not to report success without this, and not to run paid DeepResearch tasks or top up your balance on its own.
  </Step>

  <Step title="Installs the skill">
    `npx skills add @valyu/cli` teaches the agent the full command surface, so it stops guessing at flags. See [Agent Skills](/integrations/agent-skills).
  </Step>

  <Step title="Runs a real research task">
    The runbook does not stop at "installed". Your agent picks something useful from what it already knows about your work, runs it through DeepResearch with a deliverable attached, then downloads the PDF and spreadsheet and opens them, so you see the output rather than a description of it.
  </Step>
</Steps>

## Prefer to do it yourself

<CardGroup cols={2}>
  <Card title="CLI" icon="terminal" href="/integrations/cli">
    Install, authenticate, and run search, content extraction, and deep research from your terminal.
  </Card>

  <Card title="Remote MCP" icon="plug" href="/integrations/mcp-server">
    Hosted server with 11 tools. Drops into Claude, Cursor, or any MCP client.
  </Card>

  <Card title="Agent Skills" icon="sparkles" href="/integrations/agent-skills">
    Skills for Claude Code, Cursor, Windsurf, and anything supporting skills.sh.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    First API request in minutes with Python, TypeScript, or REST.
  </Card>
</CardGroup>

## Agent-readable surfaces

Every surface here has a machine-readable form. Point an agent at these directly rather than scraping HTML.

| Surface                                                                                            | What it is                                                                |
| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [valyu.ai/agents.md](https://www.valyu.ai/agents.md)                                               | Executable setup runbook - install, auth, verify, first query             |
| [docs.valyu.ai/AGENTS.md](https://docs.valyu.ai/AGENTS.md)                                         | Integration reference: endpoint choice, source presets, querying well     |
| [docs.valyu.ai/llms.txt](https://docs.valyu.ai/llms.txt)                                           | Docs index sized for one context window (full corpus at `/llms-full.txt`) |
| [docs.valyu.ai/mcp](https://docs.valyu.ai/mcp)                                                     | Hosted MCP server over these docs, so an agent can search them as a tool  |
| Append `.md` to any page URL                                                                       | Markdown version of that page                                             |
| [valyu.ai/.well-known/mcp/server-card.json](https://www.valyu.ai/.well-known/mcp/server-card.json) | Machine-readable card for the hosted MCP server and its tools             |

<Tip>
  The free signup credits cover web and open academic sources. SEC filings, patents, drug discovery, genomics, and advanced company financials need a plan, which also lowers your cost per credit. See [pricing](/pricing).
</Tip>
