Skip to main content

Create agent from template Private Preview

TL;DR

Step-by-step guide to creating a context agent from a template in Atlan, from picking the template through to your first preview run.

Connect

Use a template to create an agent that reads a knowledge source and produces the outcome that template is built for. Setup takes six steps and ends with an optional preview run.

The template available in this release is the Business Graph Term Generator, which creates and enriches business graph terms. The flow below is the same whichever template you pick.

Prerequisites​

Before you begin, make sure you have:

  • Workspace admin or governance admin access. Creating and running agents is an admin-only capability in this release
  • Agent templates enabled on your tenant. If you don't see a Create agent button in Agents studio, raise a support request
  • At least one knowledge source connected. An agent can only read a source your workspace has already connected, see Knowledge sources

Create the agent​

  1. In your Atlan workspace, click Agents from the left sidebar to open Agents studio.
  2. Click Create agent in the top-right corner.
  3. Select a template. Business Graph Term Generator is available in this release; templates under Coming soon can't be used yet.

The wizard opens on the first of six steps.

Step 1: Overview​

Read-only. It lists every source this template can read and whether your workspace has connected it. A source marked Not configured carries a Set up link that opens Settings in a new tab.

Below that, What it does describes the four behaviours of the template, including the one thing it refuses to do.

Step 2: Basic metadata​

FieldRequiredWhat to enter
NameYesA specific name for this agent. It's pre-filled with the template name, so change it.
DescriptionNoWhat this copy of the template is for, and who owns it.
The name is permanent, and it names your glossary

Every run publishes into a single glossary named after this agent, and the name can't be changed after the agent is created. Logistics Business Glossary is a good name. Leaving the template default means every agent your team creates carries the same name.

The description isn't a prompt. The template already carries the working instructions, so use this field to say which copy of the template this is, for example Generates logistics business terms from the supply-chain Confluence space. Owned by the logistics data steward.

Step 3: Sources and scope​

  1. Under Choose source, select at least one source. Only connected sources appear here.
  2. Under Where does it look?, enter the repositories, spaces, or folders the agent needs to focus on. You get one field per selected source, with a limit of 1000 characters each.
info

Scope is a hint, not a filter. Leaving it empty lets the agent search everything it can see, and the agent may read outside what you list. If content must never be read, exclude it from the connection's token scope instead. That's the boundary Atlan enforces.

Step 4: Guidance​

Enter your Run instructions, up to 1000 characters. This is the field that decides what the agent brings back, and it's required before you can preview.

Run instructions are sent with every run, including scheduled ones, and you can change them later without creating a new version of the agent.

For what to write, see Write run instructions.

Step 5: Skills​

Optional. A skill is a reusable, named capability that tells an agent how to perform a task: the business logic to follow, the steps to take, and the edge cases to call out. Because skills are assets in Atlan, one skill can serve many agents. Use one for something specific to your organization, such as a naming convention, a domain rule, or a review procedure.

You can skip this step. The template already carries the platform skills it needs, and the panel tells you how many are bound. Add a skill only for a house rule the template can't know, for example every term name is singular and title-cased.

There are two ways to add one:

  • Select a skill your workspace has already written. Search by name, description, or tag, then tick it. Anything you tick is bound to this agent, so every run has it.
  • Create a new one. Click Add a skill, then drag in a skill folder or a .zip, upload files, or pick one from the skill hub. It's selected for this agent as soon as it's created.

Platform skills are always bound and aren't listed, so the search results show only skills your workspace authored.

Step 6: Review​

Check the read-back, which shows what each unfilled field falls back to, then choose how to finish.

ButtonWhat happens
Create without runningCreates the agent and stops. Nothing runs and nothing is written. Run instructions aren't required for this path.
Create and previewCreates the agent and immediately starts a sample run.
info

Choose Create and preview. A sample run takes a minute or two, publishes nothing, and tells you whether your instructions landed before you commit to a full run.

What happens next​

The agent opens on its own page, where you can read the sample output, adjust settings, run in full, and set a schedule. See Run and schedule an agent.

Need help​

If you need assistance after reviewing this page, contact Atlan support.

See also​