> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pipeshub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Agent Setup Guide

> Step-by-step guide to creating and configuring AI agents

<div className="max-w-2xl mx-auto mt-12">
  <div className="p-6 border border-gray-200 dark:border-gray-700 rounded-lg bg-blue-50 dark:bg-gray-800">
    <div className="flex items-center mb-4">
      <span className="text-4xl mr-3">🛠️</span>
      <h2 className="text-2xl font-semibold m-0">Agent Setup Guide</h2>
    </div>

    <p className="text-lg text-gray-700 dark:text-gray-300 mb-4">Create your first AI agent with the visual flow builder</p>
  </div>
</div>

## Prerequisites

Before creating an agent, ensure you have:

1. **AI Models Configured** - At least one reasoning-enabled LLM provider set up in your organization
2. **Toolsets Configured** (optional) - Any external toolsets you want the agent to use
3. **Knowledge Sources** (optional) - Connectors or collections for document search

<Warning>
  Toolsets must be authenticated before they can be added to an agent. If you plan to use Jira, Slack, or other external toolsets, configure them first in **Settings > Toolsets**.
</Warning>

***

## Step 1: Navigate to Agents

1. From the main navbar, click **"Agent (Beta)"**

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/navigate-to-agents.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=98f7ca8243bf344ff923fc582dd9fd8a" alt="Navigate to Agents in sidebar" className="block mx-auto w-11/12" width="1917" height="913" data-path="images/agents/navigate-to-agents.png" />
</div>

2. You'll land on the **Agents Management** page showing your existing agents (if any)

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/agents-management-page.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=dbbf2e73dbe4627ae0072591d7b9fe44" alt="Agents Management Page" className="block mx-auto w-11/12" width="1912" height="904" data-path="images/agents/agents-management-page.png" />
</div>

***

## Step 2: Create New Agent

Click the **"+ New Agent"** button in the top-right corner

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/new-agent-button.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=7e67763c3f20f9ad63b2ff6c58bba376" alt="New Agent Button" className="block mx-auto w-11/12" width="1898" height="891" data-path="images/agents/new-agent-button.png" />
</div>

***

## Step 3: Configure Agent Core

The **Agent Builder** opens with a visual flow canvas. You'll see an **Agent Core** node already placed on the canvas.

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/agent-builder-canvas.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=03b1c85d566cf4f0de7742635d905439" alt="Agent Builder Canvas" className="block mx-auto w-11/12" width="1899" height="891" data-path="images/agents/agent-builder-canvas.png" />
</div>

### Configure the Agent Core

1. Click the **edit pencil icon** near the System Prompt section to open the configuration dialog
2. Fill in the following fields:

| Field             | Description                                                     | Example                                                                                   |
| ----------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| **System Prompt** | Instructions that define the agent's behavior                   | "You are a helpful project management assistant..."                                       |
| **Description**   | Brief description of what the agent does                        | "Helps manage Jira tickets and Confluence docs"                                           |
| **Start Message** | Initial greeting when users start a conversation                | "Hi! I can help you manage your projects. What would you like to do?"                     |
| **Instruction**   | Detailed instructions for the agent's behavior and capabilities | "You can create Jira tickets, search documentation, and answer questions about projects." |

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/agent-core-config.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=781821b3920d3ae8e668a4930b2437e6" alt="Agent Core Configuration Dialog" className="block mx-auto w-11/12" width="1917" height="910" data-path="images/agents/agent-core-config.png" />
</div>

3. Click **"Save Changes"** to apply the configuration

<Info>
  The **System Prompt** is crucial for defining your agent's behavior. Be specific about what the agent should and shouldn't do, its tone, and any constraints.
</Info>

***

## Step 4: Add Reasoning LLM Model

Every agent needs at least one reasoning-enabled LLM model to power its intelligence.

1. In the left sidebar, expand the **"LLM Models"** section
2. Drag a LLM model node onto the canvas

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/drag-llm-model.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=90d604d465c72bfe05944f3059b9ea12" alt="Drag Reasoning Model to Canvas" className="block mx-auto w-11/12" width="1900" height="889" data-path="images/agents/drag-llm-model.png" />
</div>

3. **Connect** the reasoning LLM model node to the Agent Core:
   * Click and drag from the output handle of the **Agent Core** node
   * Connect to the input handle of the **MODEL PROVIDER** node

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/connect-llm-model.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=2a9725c0c33fd9d93c056f166bde649f" alt="Connect Reasoning Model to Agent Core" className="block mx-auto w-11/12" width="1901" height="888" data-path="images/agents/connect-llm-model.png" />
</div>

<Info>
  **Reasoning models** are LLM models with reasoning capabilities enabled, allowing the agent to think through complex problems step-by-step before responding.
</Info>

***

## Step 5: Add Toolsets (Optional)

Toolsets give your agent the ability to interact with external applications.

### Viewing Available Toolsets

1. In the left sidebar, expand the **"Tools"** section
2. Expand **"APPLICATIONS"** to see authenticated toolsets with the number of tools each provides:

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/sidebar-toolsets.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=40e23db66cd5d18fd9e42042e002bac2" alt="Toolsets in Sidebar" className="block mx-auto w-11/12" width="1915" height="908" data-path="images/agents/sidebar-toolsets.png" />
</div>

### Adding Toolsets to Your Agent

You have two options for adding tools:

**Option 1: Drag Entire Toolset**

* **Drag** the entire toolset onto the canvas to add all its tools
* **Connect** the toolset node to your Agent Core

**Option 2: Drag Individual Tools**

* Expand a toolset to see its individual tools
* **Drag** specific tools you need onto the canvas
* This gives you more control over which tools the agent can use

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/add-toolset-to-flow.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=55009c7dde4e76d1d5e329eacd01a847" alt="Add Toolset to Agent Flow" className="block mx-auto w-11/12" width="1900" height="894" data-path="images/agents/add-toolset-to-flow.png" />
</div>

### Managing Tools

* **Remove individual tool**: Click the remove button on the right side of any tool in the toolset node
* **Remove entire toolset**: Click the delete button in the top-right corner of the toolset node

<Info>
  See the individual [Toolset Documentation](/toolsets/overview) for complete details on each toolset's tools and capabilities.
</Info>

***

## Step 6: Add Knowledge Sources (Optional)

Give your agent access to your indexed documents and collections.

1. In the left sidebar, expand the **"Knowledge"** section
2. You'll see:
   * **Apps** - Indexed content from connected applications
   * **Collections** - Your custom document collections

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/sidebar-knowledge.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=cd7d3d5ba9929892c9a3a40127627e1b" alt="Knowledge Sources in Sidebar" className="block mx-auto w-11/12" width="1915" height="908" data-path="images/agents/sidebar-knowledge.png" />
</div>

3. **Drag** the knowledge source onto the canvas
4. **Connect** it to your agent flow

The **Internal Retrieval** tool is a built-in utility that searches across all your indexed content. It requires no additional configuration and is always available.

## Step 7: Save Your Agent

1. Enter a name for your agent in the **header input field** (top of the page)
2. Click the **"Save Agent"** button

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/save-agent.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=70cf6e342495e7bb6b8178fbf856d6e7" alt="Save Agent" className="block mx-auto w-11/12" width="1903" height="894" data-path="images/agents/save-agent.png" />
</div>

3. Your agent is now saved and ready to use!

***

## Step 8: Test Your Agent

1. After saving, you can navigate to the agent's chat interface
2. Click on your agent from the **Agents Management** page
3. Start a conversation to test its capabilities

<div className="text-center">
  <img src="https://mintcdn.com/pipeshub/Ef9O83mYdBjRZ6e3/images/agents/agent-chat.png?fit=max&auto=format&n=Ef9O83mYdBjRZ6e3&q=85&s=9923a921ebca17007be963af85c3f917" alt="Agent Chat Interface" className="block mx-auto w-11/12" width="1901" height="891" data-path="images/agents/agent-chat.png" />
</div>

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Toolset not appearing in sidebar">
    **Possible causes:**

    * The toolset is not configured in Settings > Toolsets
    * The toolset is not authenticated (OAuth flow not completed)

    **Solution:**

    1. Go to **Settings > Toolsets**
    2. Find the toolset and click "Configure"
    3. Complete the authentication flow
    4. Return to the Agent Builder - the toolset should now appear
  </Accordion>

  <Accordion title="Agent not responding or timing out">
    **Possible causes:**

    * Reasoning model not properly configured or reasoning not enabled
    * Toolset authentication expired
    * System prompt causing issues

    **Solution:**

    1. Check that your LLM provider is properly configured with reasoning enabled in **Settings > AI Models**
    2. Re-authenticate any toolsets that may have expired tokens
    3. Simplify the system prompt and test again
  </Accordion>

  <Accordion title="Knowledge retrieval returning no results">
    **Possible causes:**

    * No content indexed for the connected sources
    * Filters too restrictive
    * Indexing still in progress

    **Solution:**

    1. Check **Connector Settings** to verify connectors are synced
    2. Verify collections have content
    3. Wait for indexing to complete if recently added
  </Accordion>

  <Accordion title="Cannot save agent">
    **Possible causes:**

    * Missing required fields (name, reasoning model)
    * Invalid node connections

    **Solution:**

    1. Ensure the agent has a name
    2. Verify at least one reasoning model is connected to the Agent Core
    3. Check all node connections are valid
  </Accordion>
</AccordionGroup>

***

## Next Steps

<div className="grid grid-cols-1 md:grid-cols-2 gap-4 mt-6">
  <a href="/toolsets/overview" className="block p-4 border rounded-lg hover:bg-gray-50 dark:hover:bg-gray-800 transition-colors">
    <h3 className="text-lg font-semibold mb-2">Configure Toolsets</h3>
    <p className="text-gray-600 dark:text-gray-400">Set up external service integrations</p>
  </a>

  <a href="/agent-guide/overview" className="block p-4 border rounded-lg hover:bg-gray-50 dark:hover:bg-gray-800 transition-colors">
    <h3 className="text-lg font-semibold mb-2">Agents Overview</h3>
    <p className="text-gray-600 dark:text-gray-400">Learn more about agent capabilities</p>
  </a>
</div>
