> ## 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 atlanai CLI; `atlanai --map json` prints its command map. 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.
# Cookbooks
> Complete common Atlan API tasks and automation workflows through concise, verifiable recipes.
Use these cookbooks to complete a bounded task with Atlan's public APIs and
supported automation tools. Each recipe states its outcome, prerequisites,
calls, and verification step, so people and agents can follow it without
reconstructing a workflow from reference pages.
These recipes use the HTTP API, which is the lowest-level surface and the one
that always works. For several of these tasks the CLI, an SDK, or MCP is the
shorter path — [pick a surface](#pick-a-surface) before you start writing
requests.
## Before you start
Direct HTTP API requests need an Atlan gateway URL and the authentication
required by that API. MCP clients complete OAuth with
[the public MCP endpoint](https://api.atlan.com/mcp). The
[CLI](/tools/cli/overview) resolves its own credential after `atlanai auth login`,
and the [tracing SDKs](/tools/sdk/overview) read an API key and workspace from your
environment. The authenticated identity determines the workspaces and actions
available to the request, whichever surface you use.
* Read [authentication](/api/how-tos/authentication) and keep credentials in an
approved secret store.
* Use workspace access deliberately. A successful request can create, change,
or expose resources only in workspaces available to the caller.
Start with the [API quickstart](/api/tutorials/quickstart) when you have not yet
verified the credential, workspace scope, and response shape in your own
environment.
## Pick a surface
Atlan exposes the same Registry through four surfaces. The API is the most
general and the most work; the others are usually shorter for the same task.
| Surface | Reach for it when | Start at |
| - | - | - |
| **CLI** (`atlanai`) | You are at a terminal or in CI, publishing skills, moving files, or inspecting traces. One command replaces a multipart request. | [CLI overview](/tools/cli/overview) |
| **MCP** | An agent should discover and read Registry artifacts as tools, or use tools from a registered downstream server. | [MCP overview](/tools/mcp/overview) |
| **Tracing SDK** | Your own agent should report its runs, cost, and scores. Python and TypeScript. | [SDK overview](/tools/sdk/overview) |
| **HTTP API** | No SDK for your language, or you need an operation the others do not expose. | [API reference](/api/references/api-reference) |
For a coding agent whose sessions you want captured with no code change at all,
neither of these applies — install the
[Claude Code trace plugin](/plugins/references/claude-code).
## By task
| Need | Shortest path | Also possible |
| - | - | - |
| Publish a skill | `atlanai skill publish` — [CLI](/tools/cli/how-tos/skills) | [API](/cookbooks/how-tos/skills) |
| Publish skills from a repository on merge | [SkillSync Action](/registry/skills/how-tos/sync-from-github) | [CLI in CI](/registry/skills/how-tos/publish-with-cli) |
| Retrieve a pinned skill version | `atlanai skill pull` — [CLI](/tools/cli/how-tos/skills) | [API](/cookbooks/how-tos/skills#find-and-retrieve-a-version) |
| Install skills into a project's coding agents | `registry add` — [package manager](/plugins/references/registry-cli) | — |
| Report an agent's runs, cost, and scores | [Tracing SDK](/tools/sdk/tutorials/quickstart) | [OTLP ingestion](/api/references/api-reference) |
| Record a run from a runtime you cannot instrument | [Agents cookbook](/cookbooks/how-tos/agents#record-a-completed-run) | — |
| Register an Agent, harness, or provider | [Agents cookbook](/cookbooks/how-tos/agents) | — |
| Publish a logical business model for agent context | [Ontology cookbook](/cookbooks/how-tos/ontology) | [MCP](/tools/mcp/overview) |
| Find and verify a registered MCP server | [MCP overview](/tools/mcp/overview) | [API](/api/references/api-reference) |
| Search or aggregate across artifacts | `atlanai search` — [CLI](/tools/cli/references/commands/search) | [MCP](/tools/mcp/registry/references/registry-search), [API](/api/references/api-reference) |
| Inspect a trace or diagnose attribution | `atlanai trace` — [CLI](/tools/cli/how-tos/traces) | [Traces](/registry/traces) |
| Recover from a failed write | [Errors and retries](/platform/references/errors-and-retries) | — |
## Cookbooks
Package, publish, find, retrieve, and inspect a reusable skill.
Find a registered server, test it, and inspect its tools.
Register Agents and record activity from an external runtime.
Publish a logical model and retrieve bounded context from an exact release.
Copy external trace evidence through OTLP and verify it in Atlan.
Recover from documented API failures without duplicating a write.
## Use the right surface
| Need | Cookbook |
| - | - |
| Create or retrieve a reusable instruction package | [Skills](/cookbooks/how-tos/skills) |
| Find and verify a registered MCP server | [MCP](/tools/mcp/overview) |
| Register an Agent that runs in an external runtime | [Agents](/cookbooks/how-tos/agents) |
| Publish logical types and retrieve release-consistent context | [Ontology](/cookbooks/how-tos/ontology) |
| Record a completed run from a coding tool | [Agents](/cookbooks/how-tos/agents#record-a-completed-run) |
| Copy trace evidence from an external store | [Trace imports](/traces/how-tos/import-traces) |
The site does not send live requests or store credentials. Run examples from an
approved development or deployment environment.