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.12
  • Connector version: 1.0.0
  • Generated with Connector SDK commit SHA: eeaf9a603e6c650b89bac7339c63f31ef77f5bcf
  • 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.12.tar.gz (160.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.12-py3-none-any.whl (187.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_agent_confluence-0.1.12.tar.gz
Algorithm Hash digest
SHA256 3d06cd0f04d59fabbeee8b66e749ea19721426fae6854d8d1cf5f24785bdd602
MD5 9c4d244d6f940d9e05b1b2c864450c8a
BLAKE2b-256 d19b2f8ce75dce656d5626f5149c2ac2e2c4fbe07895a9897cd0124b68a7fd73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_confluence-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 5b6c63929f765af659ba2c1b499c8fc718f959de9d3d18d10548599e351f9cc5
MD5 6d973272b205f1bb25d4301b433aa10f
BLAKE2b-256 2e248c41c2bea3270fdc9a8c2311397cd2596feaa603d3289969d1e0f90d0c7a

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