URL: /docs/agent-setup

---
title: "Give your agent the directory"
sidebarTitle: "Agent setup"
description: "One line, pasted into any coding agent. It connects the Revised MCP server, orients itself on your plan, and starts searching the directory."
icon: "bot"
---

{/* Default page mode, so the shell keeps the sidebar, breadcrumb and TOC and
    renders the frontmatter title as the h1. This wrapper only scopes the
    tokens the terminal block below uses. */}
<div class="agent-setup-page">

<div class="agent-prompt">
  <div class="agent-prompt-bar">
    <span class="agent-prompt-dot" /><span class="agent-prompt-dot" /><span class="agent-prompt-dot" />
    <span class="agent-prompt-title">the whole setup</span>
  </div>
  <div class="agent-prompt-body">
    <span class="agent-prompt-caret">&gt;</span>
    <code>Fetch and follow the setup instructions for Revised at https://getrevised.com/docs/agent-setup/prompt.md</code>
  </div>
  <div class="agent-prompt-foot">
    <CopyPrompt
      href="/docs/agent-setup/prompt.md"
      subject="Revised"
      title="Connects your agent to the Revised directory"
    />
    <span class="agent-prompt-note">Works in any MCP client. The five below are the ones with a written guide.</span>
  </div>
</div>

Your agent fetches [the instructions](/docs/agent-setup/prompt), adds the MCP server,
reads your plan and reveal allowance, and learns the handful of things about this
directory that are not guessable — that category codes are ours and not English
words, that search does not match real domain names, and that only `open`-tier
names may be republished.

<Note>
  Authentication is OAuth, so there is a step your agent cannot do for you: it
  will add the server and then wait while you sign in through your browser. No
  key to paste, and none sitting in a config file. For CI or a container with no
  browser, create an API key at [getrevised.com/account](https://getrevised.com/account)
  instead.
</Note>

## Rather do it by hand

Each of these is a real guide, not a variant of the same page — the config file
and the login step differ per client.

<CardGroup cols={2}>
  <Card title="Claude Code" icon="terminal" href="/docs/mcp/install/claude-code">
    One `claude mcp add`, then the first tool call opens the browser handshake.
  </Card>
  <Card title="Claude Desktop" icon="message-square" href="/docs/mcp/install/claude-desktop">
    Add it as a connector in settings, or edit the desktop config JSON.
  </Card>
  <Card title="Cursor" icon="code" href="/docs/mcp/install/cursor">
    Two lines in `mcp.json`, then **Needs login** in Settings → MCP.
  </Card>
  <Card title="Codex" icon="square-terminal" href="/docs/mcp/install/codex">
    `codex mcp add --url`, then `codex mcp login` for the OAuth round trip.
  </Card>
  <Card title="VS Code, opencode, others" icon="plug" href="/docs/mcp/install/other-clients">
    The generic shape, and what every client needs to be told.
  </Card>
</CardGroup>

## What it can do once it is in

| | |
| --- | --- |
| **Search** | The whole directory, filtered on category, TLD, tier, spam band, age, Revised Score and Agent Citability. Free and unlimited inside your rate limit. |
| **Read** | Referring domains, archived snapshots, the sites that link in, and when availability was last re-checked — as bands, not invented precision. |
| **Reveal** | Turn a masked listing into a real name. The only tool that spends, and `open`-tier names cost nothing. |
| **Hold** | Reserve a candidate inside Revised while a person decides, instead of revealing five more. |

Nine tools in total. [Tools](/docs/mcp/tools) is the reference; [Find domains with Claude Code](/docs/guides/claude-code) is the workflow.

## What it will not do

**It will not spend without asking.** The instructions tell the agent to report
your reveal position before anything costs, and to ask before revealing a
`regular` or `featured` listing.

**It will not republish masked names.** `regular` and `featured` names are
disclosed under the [API terms](https://getrevised.com/terms) only. The setup
prompt says so, and says it before the agent has any names to be careless with.

**It will not tell you a name is available.** `availability_checked_at` is when
Revised last looked. Verify at a registrar before you act.

</div>

<style>
{`
/* The one piece of high contrast on the page: show the prompt rather than
   hiding it behind a button, so you can read exactly what is going on your
   clipboard before pasting it into something that will act on it. */
.agent-setup-page {
  --rv-term-bg: oklch(0.19 0.02 295);
  --rv-term-text: oklch(0.78 0.11 295);
}

.agent-prompt {
  border: 1px solid var(--tangly-color-border);
  border-radius: 0.375rem;
  overflow: hidden;
  margin-bottom: 2rem;
}
.agent-prompt-bar {
  display: flex;
  align-items: center;
  gap: 0.375rem;
  padding: 0.55rem 0.75rem;
  background: var(--tangly-color-bg-elevated);
  border-bottom: 1px solid var(--tangly-color-border);
}
.agent-prompt-dot {
  width: 0.5rem;
  height: 0.5rem;
  border-radius: 9999px;
  background: var(--tangly-color-border);
}
.agent-prompt-title {
  margin-left: 0.4rem;
  font-family: var(--tangly-font-mono);
  font-size: 0.6875rem;
  color: var(--tangly-color-muted);
}
.agent-prompt-body {
  display: flex;
  gap: 0.6rem;
  padding: 1rem 1rem 1.1rem;
  background: var(--rv-term-bg);
}
.agent-prompt-caret {
  color: var(--rv-term-text);
  font-family: var(--tangly-font-mono);
  font-size: 0.8125rem;
  line-height: 1.6;
  user-select: none;
}
/* Scoped under .prose-tang deliberately: the theme styles inline code as a
   light chip (background + hairline border), which is invisible on the
   terminal's dark surface. Matching its specificity is the only way to undo
   it without !important. */
.prose-tang .agent-prompt-body code {
  font-family: var(--tangly-font-mono);
  font-size: 0.8125rem;
  line-height: 1.6;
  color: #e8e8e8;
  word-break: break-word;
  background: none;
  border: 0;
  padding: 0;
}
.agent-prompt-foot {
  display: flex;
  flex-wrap: wrap;
  align-items: center;
  gap: 0.75rem;
  padding: 0.75rem 1rem;
  border-top: 1px solid var(--tangly-color-border);
}
.agent-prompt-note {
  font-size: 0.75rem;
  color: var(--tangly-color-muted);
}
`}
</style>
