Confluence MCP

🚀 Confluence MCP Server

A Model Context Protocol (MCP) server designed for Confluence, enabling AI assistants to interact with Confluence content through standardized interfaces.

ℹ️ There is also a separate MCP server for Jira.

✨ Features

• Authenticate using personal API tokens.
• Retrieve and search Confluence pages and spaces.
• Create and update Confluence content.
• Retrieve and add page comments.
• Retrieve and add page attachments.
• Clean and transform Confluence content for AI use.
• Handle API communication, error handling, and data transformation.
• Basic rate-limiting functionality to prevent API abuse.

📦 Prerequisites

• Bun (version 1.0.0 or higher).
• A Confluence account with API access.

📦 Installation

# Clone the repository
git clone https://github.com/cosmix/confluence-mcp.git
cd confluence-mcp

# Install dependencies
bun install

# Build the project
bun run build

📚 Configuration

To use this MCP server, you need to set the following environment variables:

CONFLUENCE_API_TOKEN=your_api_token
CONFLUENCE_BASE_URL=your_confluence_instance_url  # e.g., https://your-domain.atlassian.net/wiki
CONFLUENCE_USER_EMAIL=your_email

Claude Desktop / Cline Configuration

Add the following configuration to your settings file:

{
  "mcpServers": {
    "confluence": {
      "command": "bun",
      "args": ["/absolute/path/to/confluence-mcp/dist/index.js"], 
      "config": {
        "developmentMode": true,
        "apiEndpoint": "http://localhost:3000"
      }
    }
  }
}

💻 Usage Examples

Development

# Run in development mode
bun run dev

# Run tests
npm test

Tools

Retrieve Content

Get Page (get_page)

get_page({
  space: string, // Space name, e.g., "MySpace"
  title: string   // Page title, e.g., "HomePage"
}): Promise<Page>

Search Content (search_content)

search_content(query: string): Promise<SearchResult[]>

Create and Update

Create Page (create_page)

create_page({
  space: string,
  title: string,
  content: string // Supports CommonMark and HTML formats
}): Promise<Page>

Update Page (update_page)

update_page({
  id: string,
  version: number,
  content: string
}): Promise<void>

Manage Content

Delete Page (delete_page)

delete_page(id: string, version?: number): Promise<void>

📄 License

This project is licensed under the MIT License.