> ## 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.

# Atlan adapter reference

> What the Atlan adapter adds to brain: the addresses it accepts, its settings, sign-in, commands, background jobs, limits, and usage reporting.

The Atlan adapter is the signed module that lets `brain` read from and publish
to Atlan Agent Registry. This page lists what it adds. For `brain`'s own
commands, see the [brain CLI reference](/open-source#where-to-find-what).

## Install and update

| Task | Command |
| - | - |
| Install | `brain adapter install atlan` |
| Check what's installed | `brain adapter list` |
| Remove | `brain adapter remove atlan` |

`brain` checks the adapter's signature and checksum before it installs it, and
checks the checksum again each time it loads it. A `brain` you built from
source has no signed origin, so it can't install the adapter.

When `brain` updates itself in the background, it updates the adapter too.

## Addresses it accepts

The adapter handles registry addresses on `atlan.com`, `atlan.dev`, and
`atlan.engineering`, and their subdomains. The address must:

* start with `https://`;
* have no user name or password, path, query, or fragment.

Use `https://api.atlan.com` unless your Atlan contact gave you a different
address. `brain` picks the Atlan adapter for these addresses on its own, so you
don't need `--adapter atlan`.

## Settings

Set these under `config` in a registry's declaration, or with `--config` on
`brain registry add`. The adapter refuses any other key, so a misspelled key
fails instead of being ignored.

| Key | What it sets | Default |
| - | - | - |
| `organisation` | The organization ID (`org_…`) `brain` records for this registry, to tell accounts apart. It doesn't choose the organization: the token does. | Filled in from your token at sign-in |
| `default_namespace` | The workspace ID that traces go to, and that a publish falls back to when the address names no workspace you can reach. | Your personal workspace |
| `channel` | The release channel skills install from. A channel serves its current release, not the newest version published. | `latest` |

```yaml theme={null}
registries:
  atlan:
    source: https://api.atlan.com
    config:
      channel: beta
```

The same, from the command line:

```bash theme={null}
brain registry add https://api.atlan.com --as atlan --config channel=beta
```

Use a channel your organization has declared.

## Sign-in and tokens

| How | Stored | Use it for |
| - | - | - |
| `brain auth login <registry> --source <address> --token-stdin`, with the token on standard input | Yes, in `~/.brain/credentials.json` | Your own machine |
| `brain auth login <registry> --source <address>` with `ATLAN_REGISTRY_TOKEN` set | Yes, like a piped token | A machine where piping is awkward. It works only when no `brain` background service is already running, because the service reads the variable. Prefer `--token-stdin`. |
| `REGISTRY_TOKEN_<NAME>` set for the run | No | CI |
| Atlan Desktop sign-in | The app's own sign-in, refreshed by the adapter | Machines with Atlan Desktop |

Signing in onboards you to Atlan Agent Registry, so it needs a token for a
person. A service account's API key works only as `REGISTRY_TOKEN_<NAME>`.

For how `brain` names, stores, and chooses between tokens, see the
[brain CLI reference](/open-source#where-to-find-what).

## What it installs and publishes

| | Behavior |
| - | - |
| Installs | Skills and plugins. Each workspace is a namespace: `<registry>/<workspace>`. |
| Publishes | Skills only. A publish that includes another kind fails with `Atlan cannot publish <kind> artifacts.` and publishes nothing. |
| Where a publish lands | The workspace the address names, by name or ID. If you can't reach a workspace by that name, your default workspace, and `brain` says so. |
| Versions | Each publish adds a version; nothing is overwritten. Publishing the same files again writes nothing. |
| Which versions install | One release per skill: the channel's current release. You can't pin `@<version>`. Archived versions, and versions waiting on a review or a security scan, aren't served. |
| Default skills | Every Atlan registry also serves an `atlanai` namespace with skills every organization gets. A skill your organization publishes with the same name takes precedence. You can't publish to or archive the `atlanai` namespace. |
| Removing a skill | When `brain` removes a skill from the registry, Atlan archives it instead of deleting it. |
| Bundle limits | 1 to 1,000 files and 20 MiB per skill. Paths must be relative, with no duplicates. |
| Retries | Up to 3 attempts, honoring the server's `Retry-After`. |

## Commands it adds

These appear only on a machine with the adapter installed.

| Command | What it does |
| - | - |
| `brain trace list` | Lists Claude Code and Codex sessions on this machine. |
| `brain trace export [<session>...]` | Sends sessions to Atlan with `--account <registry>`, or writes them to a folder with `--to <folder>`. Work still in progress stays on this machine until it finishes. |
| `brain telemetry status`, `on`, `off`, `reset` | Shows or changes the usage and crash data the adapter sends. |

Options for `brain trace`:

| Option | What it does |
| - | - |
| `--account <registry>` | The signed-in account that receives the traces. |
| `--for claude,codex` | Which coding agents' transcripts to read. Every one unless set. |
| `--content <mode>` | Whether prompts and completions leave the machine: `store` (the default) or `drop`. |
| `--since <date>` | Send again, from the start, sessions changed since this ISO 8601 date. It doesn't skip older sessions that were never sent. |
| `--to <folder>` | Write batches to a folder instead of sending them. |
| `--dry-run` | Read and redact into a local folder, send nothing, and don't mark sessions as sent. |

## Background jobs it adds

The adapter adds two kinds of job to `brain job add`. Both need
`--account <registry>`. `brain help job add` doesn't list them yet.

| Flag | What the job does | Extra options |
| - | - | - |
| `--traces` | Sends new coding-agent sessions to Atlan. | `--cwd <folder>`, repeatable; `--content store` or `--content drop` |
| `--personal-skills` | Publishes the skills in `~/.claude/skills`, `~/.codex/skills`, and `~/.agents/skills` to your personal workspace. It doesn't change those folders. | |

## Environment variables

| Variable | Effect |
| - | - |
| `ATLAN_REGISTRY_TOKEN` | The token `brain auth login` uses when you don't pipe one, if no `brain` background service was already running. |
| `DO_NOT_TRACK`, `REGISTRY_NO_TELEMETRY` | Any value other than empty, `0`, or `false` turns off usage and crash reporting. |

For every other `brain` variable, see the
[brain CLI reference](/open-source#where-to-find-what).

## Usage and crash reporting

`brain` sends nothing on its own. Installing the Atlan adapter turns on two
kinds of reporting:

* **Usage events.** Counts of what is installed, how runs and commands ended,
  and which versions are running. After you sign in, they carry your
  organization and user IDs.
* **Crash reports.** Error details with an anonymous ID that isn't linked to
  your usage events.

Run `brain telemetry status` to see what is on, and `brain telemetry off` to
turn both off.

## Exit statuses

The adapter uses `brain`'s exit statuses, listed in the
[brain CLI reference](/open-source#where-to-find-what). One case is specific to
Atlan: when Atlan refuses the token you piped in, `brain auth login` exits with
status 1 and shows `HTTP 401`.

See [Errors with Atlan](/tools/brain/troubleshooting/atlan-errors).


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