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

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the SDK. To install or publish skills from a terminal, use the `brain` CLI; `brain --map json` prints its command map. The `atlanai` CLI is deprecated. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.
> These docs cover Atlan Agent Registry, Atlan's hosted product. The open-source agent registry specification and its CLI (`brain`) are documented, released and maintained in their own repository; /open-source on this site links to it. Answer general specification or `brain` command questions from the project's own docs, and use these docs only for Atlan-specific setup such as the Atlan adapter, sign-in and workspaces.

# Bring agent into Atlan

> Register an agent from its repository with Atlan Desktop: add its skills and context, open a pull request for its setup, and send its first trace.

Bringing an agent into Atlan registers the agent that lives in a repository on your Mac, adds the skills and instructions it uses, and sends its first trace, so your team can find it, run it, and see how it does. Use it the first time you put an agent you already have into Atlan. Without Atlan Desktop, or to fill in an agent's details by hand, see [Create agent in Atlan](/registry/agents/how-tos/create-agent).

## Before you begin

Before you start, make sure you have:

* **Atlan Desktop on macOS**: Signed in to your organization.
* **Claude Code or Codex**: Installed on the same Mac and signed in. Atlan runs the setup in it.
* **Agent repository**: The repository your agent lives in, cloned on this Mac.
* **Workspace write permission**: Permission to add agents to the workspace. Workspaces where you lack it are disabled in the picker, with the reason on hover.

<Steps>
  <Step title="Open Bring agent flow" id="open-bring-agent-flow">
    In Atlan Desktop, select **New**, then **Agent**. The dialog **Bring an agent into** opens on the workspace you're in, or your personal workspace. To register the agent somewhere else, choose another workspace in its title.
  </Step>

  <Step title="Pick agent repository" id="pick-agent-repository">
    Select the repository your agent lives in from the repositories on this Mac, then select **Continue**.

    Atlan reads the code for what the agent does, the model it uses, and how to run it once. Nothing is changed while it reads. If the repository holds more than one agent, **Which agent?** asks you to pick one; add the others later.
  </Step>

  <Step title="Approve setup steps" id="approve-setup-steps">
    Your coding agent runs five steps. Each command it runs waits for you to choose **Allow**:

    | Step | What it does |
    | - | - |
    | **Add it to Atlan** | Registers the agent in the workspace. |
    | **Add its skills** | Adds every skill in the repository the agent uses, and links each one to it. |
    | **Bring its context** | Adds the instructions and prompts the agent reads, so your team sees what it works from. |
    | **Open a pull request** | Saves the agent's setup on a branch and opens a pull request. Nothing changes until you merge, and the agent's key stays on this Mac, never in the pull request. |
    | **Send a first trace** | Runs the agent once, if you choose to in the next step. |

    If the push fails, Atlan keeps the changes on a local branch and tells you its name, so you can push it and open the pull request yourself.
  </Step>

  <Step title="Send first trace" id="send-first-trace">
    Under **First trace**, choose how the agent's first run reaches Atlan:

    * **Run it once now**: Runs the agent from the pull request's branch on this Mac. Select **Run it now**.
    * **Wait for a real run**: The first trace arrives after you merge the pull request and add the agent's key where it runs. Select **View profile**.

    Use the agent's own key where it runs. Runs sent with a personal key are filed under that person; see [Traces appear under person instead of agent](/registry/traces/troubleshooting#traces-appear-under-person-instead-of-agent).
  </Step>

  <Step title="Verify agent and first trace" id="verify-agent-and-first-trace">
    Open the agent's profile and select **Usage**. After **Run it once now**, the run appears there. It can take a few minutes to land, and the **Usage** tab keeps checking.

    Then merge the pull request so the agent's setup reaches its repository.
  </Step>
</Steps>

## Troubleshooting

If the dialog says to install Claude Code or Codex, install one on this Mac and sign in. If it says **Couldn't start the coding agent**, check that the coding agent is signed in. If Atlan needs your OK to work in the folder, pick the repository again and choose **Allow**. If no agent is found, select **Pick another repository**, or **Add manually** to [create the agent by hand](/registry/agents/how-tos/create-agent). If the first trace doesn't arrive, see [Traces troubleshooting](/registry/traces/troubleshooting).

## Next steps

* [Find and assess skills](/registry/skills/how-tos/discover-and-use): Check the skills your agent now uses, with their versions, sources, and scans.

## See also

* [How agents work](/concepts/how-agents-work): What an agent record holds and what its profile shows.
* [Create agent in Atlan](/registry/agents/how-tos/create-agent): Register an agent by filling in its details.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.