# Confluence

```json
{
  "name": "Confluence",
  "slug": "confluence",
  "url": "https://composio.dev/toolkits/confluence",
  "markdown_url": "https://composio.dev/toolkits/confluence.md",
  "logo_url": "https://logos.composio.dev/api/confluence",
  "categories": [
    "collaboration & communication"
  ],
  "is_composio_managed": true,
  "updated_at": "2026-05-12T10:07:19.794Z"
}
```

![Confluence logo](https://logos.composio.dev/api/confluence)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Confluence MCP or direct API to create pages, search knowledge bases, update documentation, and manage spaces through natural language.

## Summary

Confluence is Atlassian's team collaboration and knowledge management platform. It helps your team organize, share, and update documents and project content in one secure workspace.

## Categories

- collaboration & communication

## Toolkit Details

- Tools: 62
- Triggers: 23
- Managed auth: Managed by Composio

## Images

- Logo: https://logos.composio.dev/api/confluence

## Authentication

- **Oauth2**
  - Type: `oauth2`
  - Description: Oauth2 authentication for Confluence.
  - Setup:
    - Configure Oauth2 credentials for Confluence.
    - Use the credentials when creating an auth config in Composio.
- **S2s Oauth2**
  - Type: `custom`
  - Description: S2s Oauth2 authentication for Confluence.
  - Setup:
    - Configure S2s Oauth2 credentials for Confluence.
    - Use the credentials when creating an auth config in Composio.
- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Confluence.
  - Setup:
    - Configure Api Key credentials for Confluence.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Create a project documentation page in Marketing space
- Add 'urgent' label to Q3 planning page
- Publish team meeting summary as a blog post
- Create a private space for product roadmap drafts

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `CONFLUENCE_ADD_CONTENT_LABEL` | Add Content Label | Tool to add labels to a piece of content. Use after obtaining the content ID to tag pages or blog posts with metadata labels. |
| `CONFLUENCE_CQL_SEARCH` | CQL Search | Searches for content in Confluence using Confluence Query Language (CQL). CQL is a powerful query language that allows you to search across all Confluence content with advanced filtering capabilities including: - Full-text search: `text ~ "search term"` - searches within page content - Title search: `title ~ "meeting notes"` - searches page titles - Label filtering: `label = "important"` - filters by labels - Space filtering: `space = DEV` - limits search to specific spaces - Type filtering: `type = page` or `type = blogpost` - filters by content type - Creator filtering: `creator = currentUser()` - filters by content creator - Date filtering: `lastModified > now("-7d")` - filters by modification date - Combined queries: `text ~ "api" AND space = DOCS AND type = page` This action uses the Confluence REST API v1 search endpoint which fully supports CQL. |
| `CONFLUENCE_CREATE_BLOGPOST` | Create Blogpost | Tool to create a new Confluence blog post. Use when you need to publish content in a specific space. Response includes `data.id` for the post ID and `data._links.base` + `data._links.webui` for the URL. |
| `CONFLUENCE_CREATE_BLOGPOST_PROPERTY` | Create Blogpost Property | Tool to create a property on a specified blog post. Use when you need to add custom metadata to a blog post. Creates a new property with a key-value pair on a specified Confluence blog post. This allows users to add custom metadata relevant to the blog post. |
| `CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_WHITEBOARD` | Create Whiteboard Property | Tool to create a new content property on a whiteboard. Use when you need to attach custom metadata to a Confluence whiteboard. |
| `CONFLUENCE_CREATE_FOOTER_COMMENT` | Create Footer Comment | Tool to create a footer comment on a Confluence page, blog post, attachment, or custom content. Use when you need to add a comment without editing the page body itself. |
| `CONFLUENCE_CREATE_PAGE` | Create Page | Tool to create a new Confluence page in a specified space. Use when you need to create new documentation or content. |
| `CONFLUENCE_CREATE_PAGE_PROPERTY` | Create Page Property | Tool to create a property on a Confluence page. Use when you need to add custom metadata or settings to a page. |
| `CONFLUENCE_CREATE_PRIVATE_SPACE` | Create Private Space | Tool to create a private Confluence space. Use when you need an isolated workspace viewable only by its creator. |
| `CONFLUENCE_CREATE_SPACE` | Create Space | Tool to create a new Confluence space. Use when setting up a new knowledge area for organization. Must include a `plain.representation` field, e.g., `{"plain": {"representation": "plain", "value": "text here"}}`. Omitting this field causes a 400 error. |
| `CONFLUENCE_CREATE_SPACE_PROPERTY` | Create Space Property | Tool to create a new property on a Confluence space. Use after confirming the space ID when adding custom metadata. |
| `CONFLUENCE_CREATE_WHITEBOARD` | Create Whiteboard | Tool to create a new Confluence whiteboard. Use when you need to start a collaborative whiteboard session. |
| `CONFLUENCE_DELETE_BLOGPOST_PROPERTY` | Delete Blogpost Property | Tool to delete a blog post property. Use when you need to remove custom metadata from a specified blog post. |
| `CONFLUENCE_DELETE_CONTENT_PROPERTY_FOR_PAGE_BY_ID` | Delete Page Content Property | Tool to delete a content property from a page by property ID. Use when you need to remove custom metadata from a page for cleanup or auditing. This action deletes a specified content property from a Confluence page using its page ID and property ID. It is useful for removing outdated or unnecessary metadata. |
| `CONFLUENCE_DELETE_CONTENT_PROPERTY_FOR_WHITEBOARD_BY_ID` | Delete Whiteboard Content Property | Tool to delete a content property from a whiteboard by property ID. Use when you need to remove custom metadata from a whiteboard. |
| `CONFLUENCE_DELETE_PAGE` | Delete Page | Tool to delete a Confluence page. Use with caution as this permanently removes the page and its content with no recovery option. In move or migration workflows, confirm all target pages were successfully created before deleting source pages — partial creation failures combined with deletion result in unrecoverable data loss. |
| `CONFLUENCE_DELETE_SPACE` | Delete Space | Tool to delete a Confluence space by its key. Use when you need to permanently remove a space. |
| `CONFLUENCE_DELETE_SPACE_PROPERTY` | Delete Space Property | Tool to delete a space property. Use when you need to remove a property from a Confluence space after review. |
| `CONFLUENCE_DOWNLOAD_ATTACHMENT` | Download Attachment | Downloads an attachment from a Confluence page and returns a publicly accessible S3 URL. Use this when you need to share the attachment with users who don't have Confluence access. First use get_attachments to list attachments and get the attachment ID. |
| `CONFLUENCE_GET_ATTACHMENT_LABELS` | Get Attachment Labels | Tool to list labels on an attachment. Use after confirming the attachment ID to fetch its labels. |
| `CONFLUENCE_GET_ATTACHMENTS` | Get Attachments | Tool to retrieve attachments of a Confluence page. Use after confirming page ID to list its attachments (supports pagination). |
| `CONFLUENCE_GET_AUDIT_LOGS` | Get Audit Logs | Tool to retrieve Confluence audit records. Use when you need to fetch and filter audit logs for compliance or troubleshooting. |
| `CONFLUENCE_GET_BLOGPOST_BY_ID` | Get Blogpost by ID | Tool to retrieve a specific Confluence blog post by its ID. Use when you have a blog post ID and need detailed metadata and content. |
| `CONFLUENCE_GET_BLOGPOST_LABELS` | Get Blogpost Labels | Tool to retrieve labels of a specific Confluence blog post by ID. Use after obtaining the blog post ID to list its labels. |
| `CONFLUENCE_GET_BLOGPOST_LIKE_COUNT` | Get Blogpost Like Count | Tool to get like count for a Confluence blog post. Use after confirming the blog post ID to retrieve total likes. |
| `CONFLUENCE_GET_BLOGPOST_OPERATIONS` | Get Blogpost Operations | Tool to retrieve permitted operations for a Confluence blog post. Use after confirming the blog post ID to see allowed actions. |
| `CONFLUENCE_GET_BLOG_POSTS` | Get Blog Posts | Tool to retrieve a list of blog posts. Use when you need a paginated list of Confluence blog posts. |
| `CONFLUENCE_GET_BLOG_POSTS_FOR_LABEL` | Get Blog Posts For Label | Tool to list all blog posts under a specific label. Use when you have a label ID and need to retrieve associated blog posts. |
| `CONFLUENCE_GET_BLOGPOST_VERSION_DETAILS` | Get Blogpost Version Details | Tool to retrieve details for a specific version of a blog post. Use when you have a blogpostId and versionNumber and need detailed metadata for that version. |
| `CONFLUENCE_GET_BLOGPOST_VERSIONS` | Get Blogpost Versions | Tool to retrieve all versions of a specific blog post. Use when you have a blogpostId and need to list version numbers. |
| `CONFLUENCE_GET_CHILD_PAGES` | Get Child Pages | Tool to list all direct child pages of a given Confluence page. Use when you have a parent page ID and need to discover its direct descendants. Response nests child page data under `data.data.results`; unwrap this before iterating. Paginate using `_links.next` cursor until no further results to avoid missing children. |
| `CONFLUENCE_GET_CONTENT_PROPERTIES_FOR_BLOG_POST` | Get Blog Post Content Properties | Tool to retrieve all content properties on a blog post. Use when you need to list metadata properties set on a specific Confluence blog post. |
| `CONFLUENCE_GET_CONTENT_PROPERTIES_FOR_PAGE` | Get Page Content Properties | Tool to retrieve all content properties on a page. Use when you need to list metadata properties set on a specific Confluence page. |
| `CONFLUENCE_GET_CONTENT_RESTRICTIONS` | Get Content Restrictions | Tool to retrieve restrictions on a Confluence content item. Use when you need to see who can view or edit a page or blog post. |
| `CONFLUENCE_GET_CURRENT_USER` | Get Current User | Tool to get information about the currently authenticated user — always scoped to the account tied to the configured connection, not arbitrary users. Use CONFLUENCE_SEARCH_USERS to look up other users. Response contains nested metadata; key fields include accountId, displayName, and email for use in downstream logic. |
| `CONFLUENCE_GET_INLINE_COMMENTS_FOR_BLOG_POST` | Get Inline Comments for Blog Post | Tool to retrieve inline comments for a Confluence blog post. Use when you need inline comment details by blog post ID. |
| `CONFLUENCE_GET_LABELS` | Get Labels | Tool to retrieve all labels in a Confluence site; use for label discovery when you need to list or page through labels. For label-based filtering, use CONFLUENCE_GET_LABELS_FOR_PAGE or CONFLUENCE_GET_LABELS_FOR_SPACE_CONTENT instead. |
| `CONFLUENCE_GET_LABELS_FOR_PAGE` | Get Page Labels | Tool to retrieve labels of a specific Confluence page by ID. Labels are returned in `data.results[*].name` and are not available in CONFLUENCE_GET_PAGES responses. Use after obtaining the page ID to list its labels. Paginate using `start` and `limit` to avoid missing labels when count exceeds 25. |
| `CONFLUENCE_GET_LABELS_FOR_SPACE` | Get Labels for Space | Tool to list labels on a space. Use when you need to retrieve labels for a specific space. |
| `CONFLUENCE_GET_LABELS_FOR_SPACE_CONTENT` | Get Labels for Space Content | Tool to list labels on all content in a space. Use when you need to retrieve or filter content labels by space, with pagination and optional prefix filtering. For label discovery across a space before per-page filtering, use this tool first, then CONFLUENCE_GET_LABELS_FOR_PAGE; CONFLUENCE_SEARCH_CONTENT does not filter by labels. |
| `CONFLUENCE_GET_PAGE_ANCESTORS` | Get Page Ancestors | Tool to retrieve all ancestors for a given Confluence page by its ID. Use when you need the full page hierarchy. |
| `CONFLUENCE_GET_PAGE_BY_ID` | Get Page by ID | Tool to retrieve a Confluence page by its ID. Use when you have a page ID and need its detailed metadata and content. Response body is in `body.storage.value` as Confluence storage format (HTML); strip tags before plain-text use. Before calling CONFLUENCE_UPDATE_PAGE, fetch the latest version here — that tool requires `version.number` = current + 1, else a 409 conflict occurs. |
| `CONFLUENCE_GET_PAGE_FOOTER_COMMENTS` | Get Page Footer Comments | Tool to retrieve footer (non-inline) comments for a Confluence page. Use when you need to collect review feedback left as standard page comments. |
| `CONFLUENCE_GET_PAGE_INLINE_COMMENTS` | Get Page Inline Comments | Tool to retrieve inline comments for a Confluence page. Use when you need inline comment details by page ID. |
| `CONFLUENCE_GET_PAGE_LIKE_COUNT` | Get Page Like Count | Tool to get like count for a Confluence page. Use after confirming the page ID to retrieve total likes. |
| `CONFLUENCE_GET_PAGES` | Get Pages | Tool to retrieve a paginated list of Confluence pages. Results are permission-scoped to the authenticated user; empty results may reflect access restrictions. Omitting filters like spaceId or status can return unexpectedly broad result sets. Labels are not included in results; use CONFLUENCE_GET_LABELS_FOR_PAGE for label data. Timestamps are ISO 8601 UTC strings. |
| `CONFLUENCE_GET_PAGE_VERSIONS` | Get Page Versions | Tool to retrieve all versions of a specific Confluence page. Use to audit edit history or to get the latest version.number before calling CONFLUENCE_UPDATE_PAGE — using a stale version.number causes a 409 Conflict error. |
| `CONFLUENCE_CONFLUENCE_GET_SPACE_BY_ID` | Get Space by ID | Tool to retrieve a Confluence space by its ID. Use when you need detailed metadata of a specific space. Space names are non-unique; use the numeric spaceId or spaceKey from the response for stable identification in downstream operations such as CONFLUENCE_GET_SPACE_PROPERTIES, CONFLUENCE_GET_LABELS_FOR_SPACE, CONFLUENCE_GET_SPACE_CONTENTS, and CONFLUENCE_CREATE_BLOGPOST. |
| `CONFLUENCE_GET_SPACE_CONTENTS` | Get Space Contents | Tool to retrieve content in a Confluence space. Use when you need to list pages, blogposts, or attachments of a specific space key. Results are in data.results (not data.page.results). Paginate via start/limit (max 200/request); follow response._links.next until absent to avoid missing content. Only returns content accessible to the authenticated user — missing items may indicate permission restrictions. Atlassian Cloud enforces HTTP 429 rate limits; throttle to ~1–2 requests/second, honor Retry-After headers, and cap start ≤ 1000 for large spaces. Construct item URLs by combining data._links.base with each item's _links.webui. |
| `CONFLUENCE_GET_SPACE_PROPERTIES` | Get Space Properties | Tool to get properties of a Confluence space. Use when you need to retrieve custom metadata or settings stored as space properties. |
| `CONFLUENCE_GET_SPACES` | Get Spaces | Tool to retrieve a paginated list of Confluence spaces with optional filtering. Paginate by incrementing `start` in steps of `limit` until fewer results than `limit` are returned. Results are scoped to spaces visible to the authenticated user; absent spaces may be restricted rather than nonexistent. Use `spaceKey` or numeric space ID (not display name) for stable identification in downstream calls. Combined filters apply as AND logic — relax filters before concluding a space is missing. |
| `CONFLUENCE_GET_TASKS` | Get Tasks | Tool to list Confluence tasks (action items) with filtering by assignee, creator, space, page, blog post, status, and dates. Use when you need to retrieve user action items without unreliable keyword searching for "TODO". |
| `CONFLUENCE_GET_USER_ANONYMOUS` | Get Anonymous User | Tool to retrieve information about the anonymous user. Use when you need to obtain guest user details before unauthenticated interactions. |
| `CONFLUENCE_SEARCH_CONTENT` | Search Content | Searches for content by filtering pages from the Confluence v2 API with intelligent ranking. Since the native search endpoint is deprecated, this action: 1. Fetches pages from the v2 pages endpoint with pagination (up to 300 pages) 2. Applies intelligent client-side filtering with relevance scoring 3. Returns results ranked by match quality (exact phrase > all words > partial matches). NOTE: Only page titles are searched — queries matching only body content return no results. Results omit full body content and canonical URLs; use CONFLUENCE_GET_PAGE_BY_ID for complete page data. Cannot filter by author, date, or labels. Results reflect only pages accessible to the authenticated user. When multiple pages share similar titles, verify the correct page via spaceId or pageId before performing writes. |
| `CONFLUENCE_SEARCH_USERS` | Search Users | Searches for users using user-specific queries from the Confluence Query Language (CQL). |
| `CONFLUENCE_UPDATE_BLOGPOST` | Update Blogpost | Tool to update a Confluence blog post's title or content. Use when you need to modify an existing blog post. Ensure you have the latest version number before calling. |
| `CONFLUENCE_UPDATE_BLOGPOST_PROPERTY` | Update Blogpost Property | Tool to update a property of a specified blog post. Use when you need to modify custom metadata on a blog post. |
| `CONFLUENCE_UPDATE_CONTENT_PROPERTY_FOR_PAGE_BY_ID` | Update Page Content Property | Tool to update a content property on a Confluence page. Use when you need to modify an existing metadata property by its ID. |
| `CONFLUENCE_UPDATE_CONTENT_PROPERTY_FOR_WHITEBOARD_BY_ID` | Update Whiteboard Content Property | Tool to update a content property on a whiteboard. Use when you need to modify metadata on a Confluence whiteboard. |
| `CONFLUENCE_UPDATE_PAGE` | Update Page | Tool to update an existing Confluence page, replacing the entire page content. Use when you need to modify existing documentation or content. |
| `CONFLUENCE_UPDATE_SPACE_PROPERTY` | Update Space Property | Tool to update a space property. Use when you need to modify custom metadata stored on a Confluence space (requires fetching the current property version first). |
| `CONFLUENCE_UPDATE_TASK` | Update Task | Tool to update a Confluence task status. Use when you need to mark tasks as complete or incomplete in workflows or dashboards. |

## Supported Triggers

| Trigger slug | Name | Description |
|---|---|---|
| `CONFLUENCE_ATTACHMENT_ADDED_TRIGGER` | New Attachment Added | Triggers when a new attachment is uploaded to a Confluence page. Optionally filters by media type. |
| `CONFLUENCE_BLOG_POST_ADDED_TO_LABEL_TRIGGER` | Blog Post Added to Label | Triggers when a new blog post is added to a specific label in Confluence. |
| `CONFLUENCE_BLOGPOST_INLINE_COMMENT_ADDED_TRIGGER` | Blogpost Inline Comment Added | Triggers when a new inline comment is added to a Confluence blog post. |
| `CONFLUENCE_BLOGPOST_LIKE_COUNT_CHANGED_TRIGGER` | Blog Post Like Count Changed | Triggers when a Confluence blog post's like count changes (someone likes or unlikes). |
| `CONFLUENCE_BLOGPOST_UPDATED_TRIGGER` | Blog Post Updated | Triggers when a Confluence blog post is updated (any edit that creates a new version). |
| `CONFLUENCE_CONTENT_RESTRICTIONS_CHANGED_TRIGGER` | Content Restrictions Changed | Triggers when view or edit restrictions change on a Confluence page or blog post. Detects user/group restrictions being added, removed, or modified. |
| `CONFLUENCE_FOOTER_COMMENT_ADDED_TRIGGER` | New Footer Comment Added to Page | Triggers when a new footer comment is added to a Confluence page. |
| `CONFLUENCE_NEW_AUDIT_LOG_TRIGGER` | New Audit Log Record | Triggers when a new audit log record is created in Confluence. Requires Confluence Standard/Premium/Enterprise plan and 'Confluence Administrator' permission. |
| `CONFLUENCE_NEW_BLOG_POST_CREATED_TRIGGER` | New Blog Post Created | Triggers when a new blog post is created in Confluence. Optionally filters by space or status. |
| `CONFLUENCE_NEW_CHILD_PAGE_TRIGGER` | New Child Page Created | Triggers when a new child page is created under a specific parent page in Confluence. |
| `CONFLUENCE_NEW_CQL_CONTENT_MATCH_TRIGGER` | New CQL Content Match | Triggers when new Confluence content appears that matches a user-provided CQL query. |
| `CONFLUENCE_NEW_TASK_CREATED_TRIGGER` | New Task Created | Triggers when a new task (action item) is created in Confluence. |
| `CONFLUENCE_PAGE_CONTENT_PROPERTIES_CHANGED_TRIGGER` | Page Content Properties Changed | Triggers when content properties on a Confluence page are added, removed, or updated. |
| `CONFLUENCE_PAGE_CREATED_TRIGGER` | New Page Created | Triggers when a new page is created in Confluence. Optionally filters by space or status. |
| `CONFLUENCE_PAGE_INLINE_COMMENT_ADDED_TRIGGER` | New Inline Comment Added to Page | Triggers when a new inline comment is added to a Confluence page. |
| `CONFLUENCE_PAGE_LIKE_COUNT_CHANGED_TRIGGER` | Page Like Count Changed | Triggers when a Confluence page's like count changes (someone likes or unlikes). |
| `CONFLUENCE_PAGE_MOVED_TRIGGER` | Page Moved | Triggers when a Confluence page is moved to a different location in the page hierarchy. |
| `CONFLUENCE_PAGE_UPDATED_TRIGGER` | Page Updated | Triggers when a Confluence page is updated (any edit that creates a new version). |
| `CONFLUENCE_PAGE_VERSION_CREATED_TRIGGER` | Page Version Created | Triggers when a new version is created for a specific Confluence page. |
| `CONFLUENCE_SPACE_CONTENT_ADDED_TRIGGER` | New Space Content Added | Triggers when new content (pages or blog posts) is added to a Confluence space. Attachments are not supported at space level; use the 'New Attachment Added' trigger instead. |
| `CONFLUENCE_SPACE_CREATED_TRIGGER` | New Space Created | Triggers when a new Confluence space is created. Optionally filters by space type or status. |
| `CONFLUENCE_SPACE_DETAILS_CHANGED_TRIGGER` | Space Details Changed | Triggers when a Confluence space's details change (name, description, status, owner, icon, etc.). |
| `CONFLUENCE_SPACE_PROPERTIES_CHANGED_TRIGGER` | Space Properties Changed | Triggers when properties on a Confluence space are added, removed, or updated. |

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Confluence Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Confluence actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Create a new Confluence page in the Engineering space titled \'Sprint Planning Notes\''
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Create a new Confluence page in the Engineering space titled \'Sprint Planning Notes\''
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Confluence tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Create a new Confluence page titled "Q2 Project Plan" in the Marketing space')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Create a new Confluence page titled "Q2 Project Plan" in the Marketing space' }],
  stopWhen: stepCountIs(5)
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Confluence Integration

- Supports both Confluence MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Confluence data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Confluence access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Confluence
- Scoped, least privilege access to Confluence resources
- Full audit trail of agent actions to support review and compliance

## Use Confluence with any AI Agent Framework

Choose a framework you want to connect Confluence with:

- [ChatGPT](https://composio.dev/toolkits/confluence/framework/chatgpt)
- [OpenAI Agents SDK](https://composio.dev/toolkits/confluence/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/confluence/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/confluence/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/confluence/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/confluence/framework/codex)
- [Cursor](https://composio.dev/toolkits/confluence/framework/cursor)
- [VS Code](https://composio.dev/toolkits/confluence/framework/vscode)
- [OpenCode](https://composio.dev/toolkits/confluence/framework/opencode)
- [OpenClaw](https://composio.dev/toolkits/confluence/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/confluence/framework/hermes-agent)
- [CLI](https://composio.dev/toolkits/confluence/framework/cli)
- [Google ADK](https://composio.dev/toolkits/confluence/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/confluence/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/confluence/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/confluence/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/confluence/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/confluence/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/confluence/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/confluence/framework/autogen)

## Related Toolkits

- [Gmail](https://composio.dev/toolkits/gmail) - Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable.
- [Outlook](https://composio.dev/toolkits/outlook) - Outlook is Microsoft's email and calendaring platform for unified communications and scheduling. It helps users stay organized with powerful email, contacts, and calendar management.
- [Slack](https://composio.dev/toolkits/slack) - Slack is a channel-based messaging platform for teams and organizations. It helps people collaborate in real time, share files, and connect all their tools in one place.
- [Gong](https://composio.dev/toolkits/gong) - Gong is a platform for video meetings, call recording, and team collaboration. It helps teams capture conversations, analyze calls, and turn insights into action.
- [Microsoft teams](https://composio.dev/toolkits/microsoft_teams) - Microsoft Teams is a collaboration platform that combines chat, meetings, and file sharing within Microsoft 365. It keeps distributed teams connected and productive through seamless virtual communication.
- [Slackbot](https://composio.dev/toolkits/slackbot) - Slackbot is a conversational automation tool for Slack that handles reminders, notifications, and automated responses. It boosts team productivity by streamlining onboarding, answering FAQs, and managing timely alerts—all right inside Slack.
- [2chat](https://composio.dev/toolkits/_2chat) - 2chat is an API platform for WhatsApp and multichannel text messaging. It streamlines chat automation, group management, and real-time messaging for developers.
- [Agent mail](https://composio.dev/toolkits/agent_mail) - Agent mail provides AI agents with dedicated email inboxes for sending, receiving, and managing emails. It empowers agents to communicate autonomously with people, services, and other agents—no human intervention needed.
- [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place.
- [Chatwork](https://composio.dev/toolkits/chatwork) - Chatwork is a team communication platform with group chats, file sharing, and task management. It helps businesses boost collaboration and streamline productivity.
- [Clickmeeting](https://composio.dev/toolkits/clickmeeting) - ClickMeeting is a cloud-based platform for running online meetings and webinars. It helps businesses and individuals host, manage, and engage virtual audiences with ease.
- [Dailybot](https://composio.dev/toolkits/dailybot) - DailyBot streamlines team collaboration with chat-based standups, reminders, and polls. It keeps work flowing smoothly in your favorite messaging platforms.
- [Dialmycalls](https://composio.dev/toolkits/dialmycalls) - Dialmycalls is a mass notification service for sending voice and text messages to contacts. It helps teams and organizations quickly broadcast urgent alerts and updates.
- [Dialpad](https://composio.dev/toolkits/dialpad) - Dialpad is a cloud-based business phone and contact center system for teams. It unifies voice, video, messaging, and meetings across your devices.
- [Discord](https://composio.dev/toolkits/discord) - Discord is a real-time messaging and VoIP platform for communities and teams. It lets users chat, share media, and collaborate across public and private channels.
- [Discordbot](https://composio.dev/toolkits/discordbot) - Discordbot is an automation tool for Discord servers that handles moderation, messaging, and user engagement. It helps communities run smoothly by automating routine and complex tasks.
- [Echtpost](https://composio.dev/toolkits/echtpost) - Echtpost is a secure digital communication platform for encrypted document and message exchange. It ensures confidential data stays private and protected during transmission.
- [Egnyte](https://composio.dev/toolkits/egnyte) - Egnyte is a cloud-based platform for secure file sharing, storage, and governance. It helps teams collaborate efficiently while maintaining data compliance and security.
- [Google Meet](https://composio.dev/toolkits/googlemeet) - Google Meet is a secure video conferencing platform for virtual meetings, chat, and screen sharing. It helps teams connect, collaborate, and communicate seamlessly from anywhere.
- [Heartbeat](https://composio.dev/toolkits/heartbeat) - Heartbeat is a plug-and-play platform for building and managing online communities. It helps you organize users, channels, events, and discussions in one place.

## Frequently Asked Questions

### Do I need my own developer credentials to use Confluence with Composio?

No, you can get started immediately using Composio's built-in Confluence app. For production, we recommend configuring your own OAuth credentials.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)
