How to integrate Confluence MCP with OpenAI Agents SDK

BOOK A CALLGET STARTED FOR FREE
Framework Integration Gradient
Confluence Logo
open-ai-agents-sdk Logo
divider

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, create a private space for product roadmap drafts 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.

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 open-ai-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.

Supported Tools & Triggers

Tools
Add Content LabelTool to add labels to a piece of content.
Get Space by IDTool to retrieve a confluence space by its id.
Create BlogpostTool to create a new confluence blog post.
Create Blogpost PropertyTool to create a property on a specified blog post.
Create Whiteboard PropertyTool to create a new content property on a whiteboard.
Create PageTool to create a new confluence page in a specified space.
Create Page PropertyTool to create a property on a confluence page.
Create Private SpaceTool to create a private confluence space.
Create SpaceTool to create a new confluence space.
Create Space PropertyTool to create a new property on a confluence space.
Create WhiteboardTool to create a new confluence whiteboard.
Delete Blogpost PropertyTool to delete a blog post property.
Delete Page Content PropertyTool to delete a content property from a page by property id.
Delete Whiteboard Content PropertyTool to delete a content property from a whiteboard by property id.
Delete PageTool to delete a confluence page.
Delete SpaceTool to delete a confluence space by its key.
Delete Space PropertyTool to delete a space property.
Get Attachment LabelsTool to list labels on an attachment.
Get AttachmentsTool to retrieve attachments of a confluence page.
Get Audit LogsTool to retrieve confluence audit records.
Get Blogpost by IDTool to retrieve a specific confluence blog post by its id.
Get Blogpost LabelsTool to retrieve labels of a specific confluence blog post by id.
Get Blogpost Like CountTool to get like count for a confluence blog post.
Get Blogpost OperationsTool to retrieve permitted operations for a confluence blog post.
Get BlogpostsTool to retrieve a list of blog posts.
Get Blog PostsTool to retrieve a list of blog posts.
Get Blog Posts For LabelTool to list all blog posts under a specific label.
Get Blogpost Version DetailsTool to retrieve details for a specific version of a blog post.
Get Blogpost VersionsTool to retrieve all versions of a specific blog post.
Get Child PagesTool to list all direct child pages of a given confluence page.
Get Blog Post Content PropertiesTool to retrieve all content properties on a blog post.
Get Page Content PropertiesTool to retrieve all content properties on a page.
Get Content RestrictionsTool to retrieve restrictions on a confluence content item.
Get Current UserTool to get information about the currently authenticated user.
Get Inline Comments for Blog PostTool to retrieve inline comments for a confluence blog post.
Get LabelsTool to retrieve all labels in a confluence site.
Get Page LabelsTool to retrieve labels of a specific confluence page by id.
Get Labels for SpaceTool to list labels on a space.
Get Labels for Space ContentTool to list labels on all content in a space.
Get Page AncestorsTool to retrieve all ancestors for a given confluence page by its id.
Get Page by IDTool to retrieve a confluence page by its id.
Get Page Like CountTool to get like count for a confluence page.
Get PagesTool to retrieve a list of pages.
Get Page VersionsTool to retrieve all versions of a specific confluence page.
Get Space by IDTool to retrieve a confluence space by its id.
Get Space ContentsTool to retrieve content in a confluence space.
Get Space PropertiesTool to get properties of a confluence space.
Get SpacesTool to retrieve a list of confluence spaces.
Get Anonymous UserTool to retrieve information about the anonymous user.
Search ContentSearches for content by filtering pages from the confluence v2 api with intelligent ranking.
Search UsersSearches for users using user-specific queries from the confluence query language (cql).
Update BlogpostTool to update a confluence blog post's title or content.
Update Blogpost PropertyTool to update a property of a specified blog post.
Update Page Content PropertyTool to update a content property on a confluence page.
Update Whiteboard Content PropertyTool to update a content property on a whiteboard.
Update PageTool to update an existing confluence page.
Update Space PropertyTool to update a space property.

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

What is Tool Router?

Composio's Tool Router 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 Tool Router

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

How the Tool Router works

The Tool Router 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

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

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

Install dependencies

pip install composio_openai_agents openai-agents python-dotenv

Install the Composio SDK and the OpenAI Agents SDK.

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.

Import dependencies

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession
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.

Set up the Composio instance

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())
What's happening:
  • load_dotenv() loads your .env file so OPENAI_API_KEY and COMPOSIO_API_KEY are available as environment variables.
  • Creating a Composio instance using the API Key and OpenAIAgentsProvider class.

Create a Tool Router session

# Create a Confluence Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["confluence"]
)

mcp_url = 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.

Configure the agent

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "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 dict includes the Composio API key for secure authentication with the MCP server.
  • require_approval: 'never' means the agent can execute Confluence operations without asking for permission each time, making interactions smoother.

Start chat loop and handle conversation

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())
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 Runner.run().
  • The responses are printed to the console, and conversations are saved locally using SQLite.
  • Typing exit, quit, or q cleanly ends the chat.

Complete Code

Here's the complete code to get you started with Confluence and open-ai-agents-sdk:

import asyncio
import os
from dotenv import load_dotenv

from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider
from agents import Agent, Runner, HostedMCPTool, SQLiteSession

load_dotenv()

api_key = os.getenv("COMPOSIO_API_KEY")
user_id = os.getenv("USER_ID")

if not api_key:
    raise RuntimeError("COMPOSIO_API_KEY is not set. Create a .env file with COMPOSIO_API_KEY=your_key")

# Initialize Composio
composio = Composio(api_key=api_key, provider=OpenAIAgentsProvider())

# Create Tool Router session
session = composio.create(
    user_id=user_id,
    toolkits=["confluence"]
)
mcp_url = session.mcp.url

# Configure agent with MCP tool
agent = 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(
            tool_config={
                "type": "mcp",
                "server_label": "tool_router",
                "server_url": mcp_url,
                "headers": {"x-api-key": api_key},
                "require_approval": "never",
            }
        )
    ],
)

print("\nComposio Tool Router session created.")

chat_session = SQLiteSession("conversation_openai_toolrouter")

print("\nChat started. Type your requests below.")
print("Commands: 'exit', 'quit', or 'q' to end\n")

async def main():
    try:
        result = await Runner.run(
            agent,
            "What can you help me with?",
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")
    except Exception as e:
        print(f"Error: {e}\n")

    while True:
        user_input = input("You: ").strip()
        if user_input.lower() in {"exit", "quit", "q"}:
            print("Goodbye!")
            break

        result = await Runner.run(
            agent,
            user_input,
            session=chat_session
        )
        print(f"Assistant: {result.final_output}\n")

asyncio.run(main())

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.

How to build Confluence MCP Agent with another framework

Claude Agent SDK

Claude Agent SDK

Use Confluence MCP with Claude Agent SDK

Google ADK

Google ADK

Use Confluence MCP with Google ADK

LangChain

LangChain

Use Confluence MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use Confluence MCP with Vercel AI SDK

Mastra AI

Mastra AI

Use Confluence MCP with Mastra AI

LlamaIndex

LlamaIndex

Use Confluence MCP with LlamaIndex

CrewAI

CrewAI

Use Confluence MCP with CrewAI

FAQ

What are the differences in Tool Router MCP and Confluence MCP?

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.

Can I use Tool Router MCP with OpenAI Agents SDK?

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.

Can I manage the permissions and scopes for Confluence while using Tool Router?

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.

How safe is my data with Composio Tool Router?

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.

Used by agents from

Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
ASU
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Book a call↗Get started for free