Managing custom Maestro agents (in preview)

Admins can create, edit, and delete custom Maestro agents from the Agents page in Maestro Studio. The Agents page shows all custom Maestro agents that you are responsible for in the environment.

Important This is a cloud-only feature. It is not supported for Collibra Platform for Government or Collibra Platform Self-Hosted (CPSH) environments.

Create a custom Maestro agent

You can create a custom Maestro agent from scratch or start from a Collibra-provided template.

Prerequisites

Steps

  1. On the main toolbar, click Products iconMaestro Studio.
    The Agents page opens. There are 2 tabs on this page. The Custom tab shows all custom Maestro agents that you own or are shared with you in this environment. The Embedded tab shows the agents are provided and maintained by Collibra.
  2. To create an agent, you can either:
    1.  Click Create Agent or select the dropdown and click Create from a template.
      A wizard-based agent builder opens.
      1. Complete all the steps in the builder. The agent is saved as a draft whenever you click Save or go to another step.
        For details on each step in the builder, go to the respective step information.
    2. From the button dropdown click Create from a template.
      The template selection wizard opens.
      1. Select the agent template you want to use.
      2. Click Create.
        An agent is created as a draft. You are automatically directed to the new agent's page.
      3. Click into any field to edit the content.
  3. Click Submit for Review in the Summary tab when the agent is ready to be published.
    When you submit an agent for review, the status is updated to Pending Review and notifies the users with the Publish Agents permission.

Manage a custom Maestro agent

Prerequisites

Steps

  1. On the main toolbar, click Products iconMaestro Studio.
  2. Go to Agents.
    The Agents page opens. This page shows all custom Maestro agents in the environment you are responsible for.
  3. Click the name of the agent you want to update.
    The Agent details page opens.
  4. Edit the agent in one of the following ways:
    1. Click directly into the field you want to update and make the changes.
    2. Click Edit to open the wizard-based agent builder and review or update any or all steps. For details on each step in the builder, go to the respective step information.
  5. Once finished you can:
    1. Click Save to save your changes as a draft.
    2. Click Submit for Review in the Summary tab if the agent is ready to be published.
    3. Click Cancel to go back without saving any changes.
  6. To duplicate or delete the agent, click the More icon and select Duplicate or Delete.

Export a custom Maestro agent

You can export a custom Maestro agent as a YAML file. You can use the exported file to import the agent into another environment or to create a copy of the agent in the same environment.

Note The YAML file contains the agent configuration, including its handle, instructions, knowledge base references, and tools. It does not include the knowledge base content itself.

Prerequisites

Steps

  1. On the main toolbar, click Products iconMaestro.
  2. Go to Agents and click the name of the agent you want to export.
    The agent details page opens.
  3. Click More icon More and select Export.
    A YAML file is downloaded to your computer. The file is named agent-{handle}-{date}.yaml.

Import a custom Maestro agent

You can import a custom Maestro agent from a YAML file that was previously exported from Maestro Studio.

Prerequisites

Steps

  1. On the main toolbar, click Products iconMaestro Studio.
  2. Go to Agents.
  3. Click Import agent.
    A file browser opens.
  4. Select the YAML file and click Save.
    If the import is successful, a confirmation message appears and the agent is added to the Agents page with a Draft status. If the agent handle already exists in this environment, the import fails with the error An agent with this handle already exists. To resolve this, open the YAML file in a text editor, update the handle value to a unique name, save the file, and try again.

Maestro agent builder

The wizard-based agent builder allows you to update every component of a custom Maestro agent.

Basic information

In the Basic information step, you define the identity of the custom Maestro agent.
This information is visible to data consumers in Maestro Assistant.

Agent instructions

In the Agent instructions step, you provide the agent with interaction details to ensure its autonomous decisions remain aligned with specific business logic and quality standards. In the instructions, you can specify the agent's role, persona, responsibilities, and tone, defining how the agent responds to prompts. You can also include guardrails such as core operating principles, governance or security protocols, and task-specific instructions. These instructions are part of the context provided to the agent with every chat interaction.

Tip Instructions that are too restrictive can interfere with the knowledge base and tools you define in later steps. Make sure the instructions are broad enough to allow the agent to perform its intended tasks.

Knowledge base

In the Knowledge base step, you select which Collibra views the agent can access. The content of these views is loaded into the agent's context as the core knowledge base. The agent consults this context before using any selected tools to search or retrieve additional information. Tools can be selected in the next step. Adding a knowledge base is optional. However, without at least a knowledge base or tool, the agent has no data to pull from.

Note Agent owners should have access to any knowledge bases associated with the agent. Without access, the knowledge base content won’t be visible to them.

To define the knowledge base:

  1. On the Knowledge base step, open the Context drop-down list and select Organization or Applications.
    Based on your selection, the Organization or Applications drop-down list appears.
  2. Select the organizations or applications you want to select views from.
    You can select multiple organizations or applications.
    As soon as you select items from the drop-down list, the Sources table appears, showing the relevant views you can select.
  3. Select the views you want the agent to reference.
    You can sort and filter the views in the table.
    The context progress bar indicates the percentage of the available capacity that is used. Hover over the information icon to see the actual number of tokens allocated.

Agent tools

By default, a custom Maestro agent can read the information from the views in its knowledge base. In the Agent tools step, you can select which additional tools are available to your agent to answer questions or complete tasks.

For all information about these tools, go to About Collibra Maestro tools (in preview).

Maestro test

In the Maestro test step, you validate the behavior of the custom Maestro agent before publishing it to the wider organization.

You can preview the agent and test it by starting a conversation. If you aren't getting the expected results, go back and edit the knowledge base, tools, and instructions.

At this point, you also define the Agent calling info, such as a welcome message, at least one example question, and an identifying color for the agent to be used in the Maestro Assistant dialog box.

Access

In the Access step, you define who can interact with the agent from the Maestro Assistant dialog box and who can manage it. By default, the agent is available to its creator only.

Summary

The Summary step gives you a high-level overview of the agent.
If one or more steps are not completed, an error is shown in the Summary step.

When the agent is ready to be published, click Submit for Review.
The agent status changes to Pending Review. Users with the Publish Agents permission receive a notification with a link to review the agent. The agent is not available in Maestro chat until it is approved and reaches Published status.

Agent statuses

Every custom Maestro agent has a status that reflects where it is in its lifecycle. Only agents with Published status are visible and callable by data consumers from Maestro Assistant.

Status Description Callable from Maestro chat
Draft The agent has been saved but not submitted for review. This is the initial status for all new agents. An agent also returns to Draft status if the owner saves changes after it has been in any other status. No
Pending Review The agent has been submitted for review and is awaiting approval from a user with the Publish Agents permission. No
Published The agent has been approved and is active. Data consumers with access to the agent can interact with it from Maestro chat. Yes
Rejected The reviewer rejected the agent. The rejection reason is shown on the agent details page. The agent owner can edit the agent and resubmit it for review. No

Approve or reject an agent

Prerequisites

Steps

  1. On the main toolbar, click Products iconMaestro Studio.
  2. Go to Agents.
    The Agents page opens. This page shows all custom Maestro agents in the environment you are responsible for.
  3. Click the name of the agent you want to review.
    The Agent details page opens.
  4. Review the agent configuration.
  5. Click Approve or Reject.
    If you reject the agent, enter a rejection reason. The reason is posted as a comment on the agent details page and the agent owner is notified.
    On approval, the agent status changes to Published and the agent becomes available in Maestro Assistant. The agent owner is notified.

Move agents between environments

You can export a custom Maestro agent from one environment and import it into another, for example to move an agent from a test environment to a production environment.

Export an agent

  1. On the main toolbar, click Products iconMaestro Studio.
  2. Go to Agents.
  3. Click the name of the agent you want to export.
  4. Click the More icon and select Export.
    A configuration file for the agent is downloaded.

Import an agent

Note The communities, domains, and views referenced in the agent's knowledge base must exist in the target environment. If they don't, you must update the knowledge base after importing.

  1. On the main toolbar, click Products iconMaestro Studio.
  2. Go to Agents.
  3. Click Import agent.
  4. Select the agent configuration file and click Import.
    The agent is created as a draft in the target environment. Review the agent configuration before submitting it for review.

What's next

Using Maestro Assistant (in preview)

Related topics