How to integrate Confluence MCP with OpenAI Agents SDK

This guide walks you through connecting Confluence to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Confluence agent that can create a project documentation page in marketing space, add 'urgent' label to q3 planning page, publish team meeting summary as a blog post through natural language commands. This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Confluence account through Composio's Confluence MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved.

Get started for freeGet a demo
Confluence logoConfluence
Oauth2S2s Oauth2Api Key

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.

62 Tools23 Triggers

Introduction

This guide walks you through connecting Confluence to the OpenAI Agents SDK using the Composio tool router. By the end, you'll have a working Confluence agent that can create a project documentation page in marketing space, add 'urgent' label to q3 planning page, publish team meeting summary as a blog post through natural language commands.

This guide will help you understand how to give your OpenAI Agents SDK agent real control over a Confluence account through Composio's Confluence MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

Also integrate Confluence with

ChatGPTClaude Agent SDKClaude CodeClaude CoworkCodexOpenCodeCursorVS CodeOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • Get and set up your OpenAI and Composio API keys
  • Install the necessary dependencies
  • Initialize Composio and create a Tool Router session for Confluence
  • Configure an AI agent that can use Confluence as a tool
  • Run a live chat session where you can ask the agent to perform Confluence operations

What is OpenAI Agents SDK?

The OpenAI Agents SDK is a lightweight framework for building AI agents that can use tools and maintain conversation state. It provides a simple interface for creating agents with hosted MCP tool support.

Key features include:

  • Hosted MCP Tools: Connect to external services through hosted MCP endpoints
  • SQLite Sessions: Persist conversation history across interactions
  • Simple API: Clean interface with Agent, Runner, and tool configuration
  • Streaming Support: Real-time response streaming for interactive applications

What is the Confluence MCP server, and what's possible with it?

The Confluence MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Confluence account. It provides structured and secure access to your Confluence spaces, pages, and content, so your agent can perform actions like creating pages, publishing blog posts, organizing spaces, and managing metadata on your behalf.

  • Automated page and space creation: Instantly create new Confluence pages or entire spaces, empowering your agent to generate project documentation, wikis, or knowledge bases as needed.
  • Effortless blog post publishing: Let your agent draft and publish new blog posts within specified Confluence spaces to keep your team up-to-date and share knowledge seamlessly.
  • Content labeling and metadata management: Have your agent add labels and custom properties to pages, blog posts, or spaces, making it easy to organize, tag, and categorize information for better discoverability.
  • Private space setup and management: Direct your agent to create private, isolated workspaces for sensitive projects or teams, ensuring only authorized collaborators have access.
  • Custom content property automation: Empower your agent to attach or update custom metadata on pages, blog posts, spaces, or whiteboards, streamlining your internal documentation workflows.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Composio API Key and OpenAI API Key
  • Primary know-how of OpenAI Agents SDK
  • A live Confluence project
  • Some knowledge of Python or Typescript
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard and create an API key. You'll need credits to use the models, or you can connect to another model provider.
  • Keep the API key safe.
Composio API Key
3

Install dependencies

npm install @composio/openai-agents @openai/agents dotenv

Install the Composio SDK and the OpenAI Agents SDK.

4

Set up environment variables

bash
OPENAI_API_KEY=sk-...your-api-key
COMPOSIO_API_KEY=your-api-key
USER_ID=composio_user@gmail.com

Create a .env file and add your OpenAI and Composio API keys.

5

Import dependencies

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';
What's happening:
  • You're importing all necessary libraries.
  • The Composio and OpenAIAgentsProvider classes are imported to connect your OpenAI agent to Composio tools like Confluence.
6

Set up the Composio instance

dotenv.config();

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});
What's happening:
  • dotenv.config() loads your .env file so COMPOSIO_API_KEY and USER_ID are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.
7

Create a Tool Router session

// Create Tool Router session for Confluence
const session = await composio.create(userId as string, {
  toolkits: ['confluence'],
});
const mcpUrl = session.mcp.url;

What is happening:

  • You give the Tool Router the user id and the toolkits you want available. Here, it is only confluence.
  • The router checks the user's Confluence connection and prepares the MCP endpoint.
  • The returned session.mcp.url is the MCP URL that your agent will use to access Confluence.
  • This approach keeps things lightweight and lets the agent request Confluence tools only when needed during the conversation.
8

Configure the agent

// Configure agent with MCP tool
const agent = new Agent({
  name: 'Assistant',
  model: 'gpt-5',
  instructions:
    'You are a helpful assistant that can access Confluence. Help users perform Confluence operations through natural language.',
  tools: [
    hostedMcpTool({
      serverLabel: 'tool_router',
      serverUrl: mcpUrl,
      headers: { 'x-api-key': composioApiKey },
      requireApproval: 'never',
    }),
  ],
});
What's happening:
  • We're creating an Agent instance with a name, model (gpt-5), and clear instructions about its purpose.
  • The agent's instructions tell it that it can access Confluence and help with queries, inserts, updates, authentication, and fetching database information.
  • The tools array includes a hostedMcpTool that connects to the MCP server URL we created earlier.
  • The headers object includes the Composio API key for secure authentication with the MCP server.
  • requireApproval: 'never' means the agent can execute Confluence operations without asking for permission each time, making interactions smoother.
9

Start chat loop and handle conversation

// Keep conversation state across turns
const conversationSession = new OpenAIConversationsSession();

// Simple CLI
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: 'You: ',
});

console.log('\nComposio Tool Router session created.');
console.log('\nChat started. Type your requests below.');
console.log("Commands: 'exit', 'quit', or 'q' to end\n");

try {
  const first = await run(agent, 'What can you help me with?', { session: conversationSession });
  console.log(`Assistant: ${first.finalOutput}\n`);
} catch (e) {
  console.error('Error:', e instanceof Error ? e.message : e, '\n');
}

rl.prompt();

rl.on('line', async (userInput) => {
  const text = userInput.trim();

  if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
    console.log('Goodbye!');
    rl.close();
    process.exit(0);
  }

  if (!text) {
    rl.prompt();
    return;
  }

  try {
    const result = await run(agent, text, { session: conversationSession });
    console.log(`\nAssistant: ${result.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();
});

rl.on('close', () => {
  console.log('\n👋 Session ended.');
  process.exit(0);
});
What's happening:
  • The program prints a session URL that you visit to authorize Confluence.
  • After authorization, the chat begins.
  • Each message you type is processed by the agent using run().
  • The responses are printed to the console.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Confluence and OpenAI Agents SDK:

import 'dotenv/config';
import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, hostedMcpTool, run, OpenAIConversationsSession } from '@openai/agents';
import * as readline from 'readline';

const composioApiKey = process.env.COMPOSIO_API_KEY;
const userId = process.env.USER_ID;

if (!composioApiKey) {
  throw new Error('COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key');
}
if (!userId) {
  throw new Error('USER_ID is not set');
}

// Initialize Composio
const composio = new Composio({
  apiKey: composioApiKey,
  provider: new OpenAIAgentsProvider(),
});

async function main() {
  // Create Tool Router session
  const session = await composio.create(userId as string, {
    toolkits: ['confluence'],
  });
  const mcpUrl = session.mcp.url;

  // Configure agent with MCP tool
  const agent = new Agent({
    name: 'Assistant',
    model: 'gpt-5',
    instructions:
      'You are a helpful assistant that can access Confluence. Help users perform Confluence operations through natural language.',
    tools: [
      hostedMcpTool({
        serverLabel: 'tool_router',
        serverUrl: mcpUrl,
        headers: { 'x-api-key': composioApiKey },
        requireApproval: 'never',
      }),
    ],
  });

  // Keep conversation state across turns
  const conversationSession = new OpenAIConversationsSession();

  // Simple CLI
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
    prompt: 'You: ',
  });

  console.log('\nComposio Tool Router session created.');
  console.log('\nChat started. Type your requests below.');
  console.log("Commands: 'exit', 'quit', or 'q' to end\n");

  try {
    const first = await run(agent, 'What can you help me with?', { session: conversationSession });
    console.log(`Assistant: ${first.finalOutput}\n`);
  } catch (e) {
    console.error('Error:', e instanceof Error ? e.message : e, '\n');
  }

  rl.prompt();

  rl.on('line', async (userInput) => {
    const text = userInput.trim();

    if (['exit', 'quit', 'q'].includes(text.toLowerCase())) {
      console.log('Goodbye!');
      rl.close();
      process.exit(0);
    }

    if (!text) {
      rl.prompt();
      return;
    }

    try {
      const result = await run(agent, text, { session: conversationSession });
      console.log(`\nAssistant: ${result.finalOutput}\n`);
    } catch (e) {
      console.error('Error:', e instanceof Error ? e.message : e, '\n');
    }

    rl.prompt();
  });

  rl.on('close', () => {
    console.log('\nSession ended.');
    process.exit(0);
  });
}

main().catch((err) => {
  console.error('Fatal error:', err);
  process.exit(1);
});

Conclusion

This was a starter code for integrating Confluence MCP with OpenAI Agents SDK to build a functional AI agent that can interact with Confluence.

Key features:

  • Hosted MCP tool integration through Composio's Tool Router
  • SQLite session persistence for conversation history
  • Simple async chat loop for interactive testing
You can extend this by adding more toolkits, implementing custom business logic, or building a web interface around the agent.
TOOLS & TRIGGERS

Supported Tools and Triggers

Every Confluence action and event your agent gets out of the box.

Add Content Label

Tool to add labels to a piece of content.

CQL Search

Searches for content in Confluence using Confluence Query Language (CQL).

Create Blogpost

Tool to create a new Confluence blog post.

Create Blogpost Property

Tool to create a property on a specified blog post.

Create Whiteboard Property

Tool to create a new content property on a whiteboard.

Create Footer Comment

Tool to create a footer comment on a Confluence page, blog post, attachment, or custom content.

Create Page

Tool to create a new Confluence page in a specified space.

Create Page Property

Tool to create a property on a Confluence page.

Create Private Space

Tool to create a private Confluence space.

Create Space

Tool to create a new Confluence space.

Create Space Property

Tool to create a new property on a Confluence space.

Create Whiteboard

Tool to create a new Confluence whiteboard.

Delete Blogpost Property

Tool to delete a blog post property.

Delete Page Content Property

Tool to delete a content property from a page by property ID.

Delete Whiteboard Content Property

Tool to delete a content property from a whiteboard by property ID.

Delete Page

Tool to delete a Confluence page.

Delete Space

Tool to delete a Confluence space by its key.

Delete Space Property

Tool to delete a space property.

Download Attachment

Downloads an attachment from a Confluence page and returns a publicly accessible S3 URL.

Get Attachment Labels

Tool to list labels on an attachment.

Get Attachments

Tool to retrieve attachments of a Confluence page.

Get Audit Logs

Tool to retrieve Confluence audit records.

Get Blogpost by ID

Tool to retrieve a specific Confluence blog post by its ID.

Get Blogpost Labels

Tool to retrieve labels of a specific Confluence blog post by ID.

Get Blogpost Like Count

Tool to get like count for a Confluence blog post.

Get Blogpost Operations

Tool to retrieve permitted operations for a Confluence blog post.

Get Blog Posts

Tool to retrieve a list of blog posts.

Get Blog Posts For Label

Tool to list all blog posts under a specific label.

Get Blogpost Version Details

Tool to retrieve details for a specific version of a blog post.

Get Blogpost Versions

Tool to retrieve all versions of a specific blog post.

Get Child Pages

Tool to list all direct child pages of a given Confluence page.

Get Blog Post Content Properties

Tool to retrieve all content properties on a blog post.

Get Page Content Properties

Tool to retrieve all content properties on a page.

Get Content Restrictions

Tool to retrieve restrictions on a Confluence content item.

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.

Get Inline Comments for Blog Post

Tool to retrieve inline comments for a Confluence blog post.

Get Labels

Tool to retrieve all labels in a Confluence site; use for label discovery when you need to list or page through labels.

Get Page Labels

Tool to retrieve labels of a specific Confluence page by ID.

Get Labels for Space

Tool to list labels on a space.

Get Labels for Space Content

Tool to list labels on all content in a space.

Get Page Ancestors

Tool to retrieve all ancestors for a given Confluence page by its ID.

Get Page by ID

Tool to retrieve a Confluence page by its ID.

Get Page Footer Comments

Tool to retrieve footer (non-inline) comments for a Confluence page.

Get Page Inline Comments

Tool to retrieve inline comments for a Confluence page.

Get Page Like Count

Tool to get like count for a Confluence page.

Get Pages

Tool to retrieve a paginated list of Confluence pages.

Get Page Versions

Tool to retrieve all versions of a specific Confluence page.

Get Space by ID

Tool to retrieve a Confluence space by its ID.

Get Space Contents

Tool to retrieve content in a Confluence space.

Get Space Properties

Tool to get properties of a Confluence space.

Get Spaces

Tool to retrieve a paginated list of Confluence spaces with optional filtering.

Get Tasks

Tool to list Confluence tasks (action items) with filtering by assignee, creator, space, page, blog post, status, and dates.

Get Anonymous User

Tool to retrieve information about the anonymous user.

Search Content

Searches for content by filtering pages from the Confluence v2 API with intelligent ranking.

Search Users

Searches for users using user-specific queries from the Confluence Query Language (CQL).

Update Blogpost

Tool to update a Confluence blog post's title or content.

Update Blogpost Property

Tool to update a property of a specified blog post.

Update Page Content Property

Tool to update a content property on a Confluence page.

Update Whiteboard Content Property

Tool to update a content property on a whiteboard.

Update Page

Tool to update an existing Confluence page, replacing the entire page content.

Update Space Property

Tool to update a space property.

Update Task

Tool to update a Confluence task status.

FRAMEWORKS

How to build Confluence MCP Agent with another framework

ChatGPT logo

ChatGPT

Use Confluence MCP with ChatGPT

Claude Agent SDK logo

Claude Agent SDK

Use Confluence MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Confluence MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Confluence MCP with Claude Cowork

Codex logo

Codex

Use Confluence MCP with Codex

Cursor logo

Cursor

Use Confluence MCP with Cursor

OpenClaw logo

OpenClaw

Use Confluence MCP with OpenClaw

Hermes logo

Hermes

Use Confluence MCP with Hermes

CLI logo

CLI

Use Confluence MCP with CLI

Google ADK logo

Google ADK

Use Confluence MCP with Google ADK

LangChain logo

LangChain

Use Confluence MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Confluence MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Confluence MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Confluence MCP with LlamaIndex

CrewAI logo

CrewAI

Use Confluence MCP with CrewAI

OpenCode logo

OpenCode

Use Confluence MCP with OpenCode

VS Code logo

VS Code

Use Confluence MCP with VS Code

FAQ

Frequently asked questions

With a standalone Confluence MCP server, the agents and LLMs can only access a fixed set of Confluence tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Confluence and many other apps based on the task at hand, all through a single MCP endpoint.

Yes, you can. OpenAI Agents SDK fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Confluence tools.

Yes, absolutely. You can configure which Confluence scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do.

All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Confluence data and credentials are handled as safely as possible.

Start with Confluence.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Confluence tool your agent needs.Free to start.

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

Karan skipped his own birthday party to fix our critical issue. It was 10pm and he diverted his Waymo to help us instead. This really sets the bar — it shows the commitment you need when users rely on your software.

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

We chose Composio over Pipedream because it delivered depth where it mattered — niche tools and tricky edge cases other platforms simply ignored. That gave us confidence to scale without compromising.

Nirman Dave
Nirman Dave
CEO, Zams

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down managing agent auth would have been a death sentence.

Ryan Yu
Ryan Yu
Founder, Extra Thursday

Before Composio, adding tool integrations was slow and resource-intensive. Each one could take weeks of engineering time, and maintaining them meant constantly keeping up with API changes.

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies