Confluence Integration

Codity integrates with Confluence via MCP (Model Context Protocol) to pull relevant documentation into the context of pull request reviews. Codity searches your Confluence space to find requirement pages relevant to the PR and uses that content to provide more accurate, requirement-aware review feedback.

Prerequisites

  • A Confluence Cloud or self-hosted Confluence instance
  • An Atlassian API token with read access to the relevant Confluence spaces
  • A running MCP server configured to connect to your Confluence instance

Setup

Step 1: Create a Confluence API Token

  1. Go to https://id.atlassian.com/manage-profile/security/api-tokens
  2. Click Create API token
  3. Enter a label such as Codity Integration
  4. Copy the token immediately: it will not be shown again

Step 2: Configure Confluence in Codity Dashboard

  1. Navigate to Settings in the Codity dashboard
  2. Find the Confluence section
  3. Enter the following:
    • Confluence URL: Your Confluence base URL (e.g., https://yourcompany.atlassian.net)
    • Email: The Atlassian account email associated with the API token
    • API Token: The token created in Step 1
    • MCP Server URL: The URL of your Confluence MCP server (e.g., http://localhost:3000)
  4. Click Test Connection to verify the credentials
  5. Click Save

How It Works

  1. Codity connects to the MCP server and retrieves the list of available tools
  2. An orchestration agent is given the PR title and description
  3. The agent calls MCP tools (such as confluence_search and confluence_read) to find relevant documentation
  4. The agent runs up to 3 rounds of tool calls to retrieve sufficient context
  5. The retrieved content is formatted and included in the review prompt

The agent extracts requirements verbatim from Confluence pages. The output format is:

CONFLUENCE REQUIREMENTS:
- <exact requirement from page>
- <exact requirement from page>
...
SOURCE: <page title>
URL: <page URL>

Token Storage and Security

  • Confluence API tokens are encrypted using Fernet symmetric encryption before being stored in the database
  • Tokens are never returned in plain text via the API
  • All communication with Confluence uses HTTPS
  • Connection tests authenticate using Basic Auth (email:token base64-encoded)

Next Steps