Configuring an agent in IBM watsonx Orchestrate

Create and configure an AI agent in the IBM watsonx Orchestrate console before integrating it with OpenPages®.

Before you begin

  • Learn about IBM watsonx Orchestrate using the documentation and resources that IBM® provides. For more information, see the IBM watsonx Orchestrate documentation.
  • Ensure you have access to the IBM watsonx Orchestrate console with appropriate permissions to create and configure agents.
  • Provide agent access to context variables. To enable an agent to use context variables at runtime, all required context variables must be explicitly defined in the agent definition. Agents can only access context variables that are declared upfront and enabled for context access. For more information, see Providing access to context variables.

    After updating the agent definition to include context variables, the agent must be updated in IBM watsonx Orchestrate so that the changes take effect. For more information, see Managing agents.

About this task

An agent in IBM watsonx Orchestrate is an AI-powered assistant that can interact with users through natural language, execute tasks, and integrate with various tools and services. When configured for OpenPages, the agent can access contextual information and perform actions on behalf of users.

Procedure

  1. Log in to the IBM watsonx Orchestrate console.
  2. Create a new agent and provide a meaningful name and description.
    The name and description help users understand the agent's purpose and capabilities.
  3. In the Profile section, select an AI model for the agent.
    Choose a model that best fits your use case and performance requirements.
  4. Customize the welcome message and quick start prompts.
    These prompts help users understand how to interact with the agent and what tasks it can perform.
  5. In the Toolset section, add tools to the agent.
    1. Click Add tool.
    2. In the Add a tool dialog box, choose a sources in the Add from section. For example, click MCP server and then Manage MCP servers to import tools from your OpenPages MCP server.
      Tools enable the agent to perform specific actions, such as querying data or executing operations in OpenPages.
    3. If you chose MCP server, select the tools from the list that you want to make available to the agent and then click Add to agent.
  6. In the Behavior section, define the agent's behavior by setting instructions and defining the required context variables.
    Instructions guide how the agent interprets user requests and uses the available tools.
    Note: Only variables listed here are available to the agent at runtime.
    Here are the context variables exposed by OpenPages that the agent can leverage:
    • op_username - User authentication token
    • op_user_profile_id - User profile ID
    • op_user_profile_name - User profile name
    • op_user_locale - User locale
    • op_base_url - OpenPages instance URL
    • op_view_type - Current view type
    • op_view_name - Current view name
    • op_object_type_name - Current object type
    • op_object_id - Current object ID
    • op_object_name - Current object name
    • op_workflow_stage - Available workflow stage
    Important: When creating custom tools, ensure these same context variables are passed as parameters to the tools so the agent can share context with the tools during execution.
  7. To deploy the agent, click Deploy.
    After an agent is deployed, it is ready to be integrated with OpenPages.
  8. Enable the agent to use context variables at runtime by ensuring that context_access_enabled: true is specified in the agent specification.

    For more information, see Providing access to context variables.

  9. In the Channels section, select Embedded Agent, and then copy the configuration snippet in the Embed on your website section.
    You will use this configuration snippet to integrate the agent with OpenPages.

What to do next

Integrate the agent with OpenPages. For more information, see Configuring the integration between an agent and OpenPages.

Configuring IBM watsonx Orchestrate agents is an iterative process. As users interact with the agent, you can refine its instructions, add new tools, and improve its capabilities based on feedback and usage patterns.