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.
1
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.
2
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.
3
Approve setup steps
Your coding agent runs five steps. Each command it runs waits for you to choose Allow:
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.
4
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.
5
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.
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. If the first trace doesn’t arrive, see Traces troubleshooting.Next steps
- Find and assess skills: Check the skills your agent now uses, with their versions, sources, and scans.
See also
- How agents work: What an agent record holds and what its profile shows.
- Create agent in Atlan: Register an agent by filling in its details.