> ## 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 `aireg` CLI; `aireg --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 Trident, Atlan's hosted product. AI Registry and Agent Registry are its earlier names. Registry OSS is Atlan's open-source agent registry: the registry specification and its aireg CLI, with their own public repository, docs and release notes; /open-source on this site links them. Registry OSS is open source; Atlan Trident is not. Answer generic aireg or specification questions from the project's docs, and use these docs for Atlan-specific setup such as the Atlan adapter, sign-in and workspaces.
> Atlan offers a second product, the Agentic Data Catalog: Atlan's enterprise context layer, covering the data catalog, connectors, lineage, data governance and glossary. It is documented at https://docs.atlan.com; answer questions about it from those docs, not these.

# Developer reference

> Choose between the Atlan HTTP API, the atlanai SDK, the aireg CLI, and MCP, and find where to start with each.

Build on Atlan Trident from code. Pick the interface that matches where your code runs, then start with its first task.

## Choose interface

| Interface | Use it when | Covers |
| - | - | - |
| [Public API](https://platform.atlan.com/api/references/api-reference.md) | Your application calls Atlan directly | Registry, skills, agents, outputs, files, MCP servers and tools, Model Gateway, and OTLP trace ingest |
| [atlanai SDK](https://platform.atlan.com/tools/sdk/overview.md) | You write Python or TypeScript | Tracing agent runs, running evals, and managing registry items |
| [`aireg` CLI](https://platform.atlan.com/tools/brain/index) | You work from a terminal or CI | Installing and publishing skills, calling the API, and sending coding-agent traces |
| [MCP reference](https://platform.atlan.com/tools/mcp/overview.md) | An agent host needs governed tools | Atlan's tools and your team's MCP servers through one Streamable HTTP endpoint |

Model calls use the OpenAI- and Anthropic-compatible endpoints of Model Gateway, so existing SDKs work by changing their base URL. See [Connect client to Model Gateway](https://platform.atlan.com/gateway/model/how-tos/connect-a-client.md).

## Get started

> [card] [Connect to Atlan Trident](https://platform.atlan.com/api/tutorials/quickstart.md)
>
> Confirm your identity and workspaces with a safe first read.

> [card] [Trace your first agent run](https://platform.atlan.com/tools/sdk/tutorials/quickstart.md)
>
> Send one run from Python or TypeScript and find it in Atlan Trident.

## Common tasks

| I want to… | Go to |
| - | - |
| Authenticate HTTP requests | [Send bearer token](https://platform.atlan.com/api/how-tos/authentication.md) |
| Register an agent over HTTP | [Register your first Agent](https://platform.atlan.com/api/tutorials/register-agent.md) |
| Send OpenTelemetry traces | [Send OTLP traces](https://platform.atlan.com/api/how-tos/send-otlp-traces.md) |
| Look up an endpoint | [Public API](https://platform.atlan.com/api/references/api-reference.md) |
| Follow an end-to-end recipe | [Cookbooks](https://platform.atlan.com/cookbooks/index.md) |
| Handle an error or retry | [Errors and retries](https://platform.atlan.com/platform/references/errors-and-retries.md) |
| Understand how the contract changes | [Preview compatibility](https://platform.atlan.com/api/references/compatibility) |

## Availability and limits

* The API is in preview. Verify HTTP, CLI, and MCP workflows in your environment before production automation depends on them.
* The reference describes a pinned public contract. In your environment, the API's response is authoritative.
* When a coding agent uses the API, give it the public OpenAPI document, have it [confirm its identity](https://platform.atlan.com/api/how-tos/authentication.md#verify-resolved-identity) with a read-only call before it writes, and keep confirmation on destructive operations.
* The generated reference is read-only. It cannot send requests or store credentials.

## Related

* [Give coding agents Atlan docs](https://platform.atlan.com/for-ai-agents.md): machine-readable entry points to these docs.


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