Skip to main content

Setting Up the Atlassian Confluence Tool

This guide will walk you through the steps to configure and authenticate the Atlassian Confluence tool.

Adding and Configuring the Confluence Tool​

  1. Add the Confluence Tool
    Navigate to the library and select the "Atlassian Confluence" tool to add it to your project.

Add JIRA tool

  1. Provide Tool Details
    For the tool, provide the required information:

    • Add the base URL for your Confluence and JIRA (e.g., https://organization.atlassian.net).
    • Select "Basic Authentication" as the authentication method.

  2. Full page content Select "Always retrieve full page content" if you want the tool to return the content of the pages searched during retrieval. If this option is not selected, only a snippet of text relevant to the search is returned, instead of the full document.

  • Due to context limits, the maximum number of pages that can be returned are 10.

Add JIRA tool

  1. Use or Create an Authentication Key

    • If you already have a Basic Authentication key, select it from the list.
    • If you need to create a new Basic Authentication key, follow these steps:
      • Enter your email address as the username.
      • Enter your API token as the password.

  2. Add the tool to an Agent Now that the tool has been saved, you can add it to an Agent and start using it to search for internal documentation. Use confluence tool

Retrieving Your API Key from Atlassian​

Follow these steps to generate an API key from your Atlassian account:

  1. Access the Security Settings
    Go to your Atlassian account and navigate to:
    Manage Profile -> Security settings, or directly visit:
    https://id.atlassian.com/manage-profile/security/api-tokens.

  2. Create a New API Token

    • Click the "Create API Token" button.
    • Provide a name for the token (e.g., "API Integration").
    • (Optional) Set an expiry date for added security.

    JIRA API tokens

  3. Use Your API Token

    • When making API requests, use your email address as the username.
    • Use the generated API token as the password.

Now that the tool has been added, you can add it to any model and start querying it with natural language. The Confluence tool can understand both CQL or natural queries, and respond with a list of tickets associated.

For improved responses, it is recommended that you add a prompt to your model as well, providing details on your Confluence project and specific fields or terminology for your organization.