Skip to main content

Airbyte Confluence Connector for AI platforms

Project description

Confluence

The Confluence agent connector is a Python package that equips AI agents to interact with Confluence through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the Confluence Cloud REST API. Provides read access to Confluence spaces, pages, blog posts, groups, and audit logs. Uses the Confluence Cloud REST API v2 for spaces, pages, and blog posts, and the v1 API for groups and audit records. Authenticates via HTTP Basic using an Atlassian account email and API token.

Example questions

The Confluence connector is optimized to handle prompts like these.

  • List all spaces in my Confluence instance
  • Show me the most recently created pages
  • List all blog posts
  • Show me details for a specific page
  • List all groups in Confluence
  • Show me recent audit log entries
  • Get details about a specific space
  • Show me blog post details
  • Find pages created in the last 7 days
  • What spaces have the most pages?
  • Show me all pages in a specific space
  • Find blog posts by a specific author
  • What audit events happened this week?

Unsupported questions

The Confluence connector isn't currently able to handle prompts like these.

  • Create a new page in Confluence
  • Update an existing page
  • Delete a space
  • Upload an attachment to a page
  • Manage space permissions

Installation

uv pip install airbyte-agent-confluence

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_confluence import ConfluenceConnector
from airbyte_agent_confluence.models import ConfluenceAuthConfig

connector = ConfluenceConnector(
    auth_config=ConfluenceAuthConfig(
        username="<Your Atlassian account email address>",
        password="<Your Confluence API token from https://id.atlassian.com/manage-profile/security/api-tokens>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@ConfluenceConnector.tool_utils
async def confluence_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. If your Airbyte client can access multiple organizations, also set organization_id.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_confluence import ConfluenceConnector, AirbyteAuthConfig

connector = ConfluenceConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@ConfluenceConnector.tool_utils
async def confluence_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity Actions
Spaces List, Get, Search
Pages List, Get, Search
Blog Posts List, Get, Search
Groups List, Search
Audit List, Search

Authentication

For all authentication options, see the connector's authentication documentation.

Confluence API docs

See the official Confluence API reference.

Version information

  • Package version: 0.1.2
  • Connector version: 1.0.0
  • Generated with Connector SDK commit SHA: b541ca65d697dad0915d1b5b8d8c756cd18299a7
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_confluence-0.1.2.tar.gz (152.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_confluence-0.1.2-py3-none-any.whl (179.8 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_confluence-0.1.2.tar.gz.

File metadata

  • Download URL: airbyte_agent_confluence-0.1.2.tar.gz
  • Upload date:
  • Size: 152.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for airbyte_agent_confluence-0.1.2.tar.gz
Algorithm Hash digest
SHA256 0eb06753eb81ce8a934f447b4be7447c82166d6dfac06993b01e67c3c5f4f0e7
MD5 5d63948e06f11f0b0d8320a3e5a36aae
BLAKE2b-256 fd20bd6ae024e8058650485155826746169b73e1484f3097bbf7731238a7e007

See more details on using hashes here.

File details

Details for the file airbyte_agent_confluence-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_confluence-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9b6819c2fdc2876714950f18eb368459244ab8a9b19e1e9e5c6a18c95d6bca75
MD5 fa34be5f191051ad092ab71572663c3f
BLAKE2b-256 bbeb05a439d472abe4188a9baab025cb652af2e1fb46293e9091d9ad9f0053ce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page