Confluence Cloud MCP

🚀 Confluence Cloud MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with Confluence Cloud. This server enables AI assistants to manage Confluence spaces, pages, and content through a unified interface.

✨ Features

• Space Management
  • List all spaces
  • Get detailed information about a specific space
• Page Operations
  • Create, read, and update pages
  • List pages in a specific space
  • Convert Confluence storage format content to Markdown
• Search and Tags
  • Search for content using CQL
  • Manage page tags

📦 Installation

Option 1: Using Docker (Recommended)

The simplest way is to use the pre-built Docker image:

docker run --rm -i \
  -e CONFLUENCE_API_TOKEN=your-api-token \
  -e CONFLUENCE_EMAIL=your-email@domain.com \
  -e CONFLUENCE_DOMAIN=your-domain.atlassian.net \
  ghcr.io/aaronsb/confluence-cloud-mcp:latest

Option 2: Local Build

1. Clone the repository:

git clone https://github.com/aaronsb/confluence-cloud-mcp.git
cd confluence-cloud-mcp

2. Run using the local build script:

# Build the Docker image
./scripts/build-local.sh

# Run the server
CONFLUENCE_API_TOKEN=your-token CONFLUENCE_EMAIL=your-email ./scripts/run-local.sh

Option 3: Build from Source

1. Install dependencies:

npm install

2. Configure environment variables: Create a .env file and add your Confluence credentials:

CONFLUENCE_DOMAIN=your-domain.atlassian.net
CONFLUENCE_EMAIL=your-email@domain.com
CONFLUENCE_API_TOKEN=your-api-token

3. Build the project:

npm run build

4. Run the server:

node build/index.js

💻 Usage Examples

Basic Usage

Integrate this server into an MCP-supported AI assistant by adding it to their MCP configuration:

{
  "servers": {
    "confluence-cloud-mcp": {
      "url": "http://localhost:3000",
      "type": "mcp"
    }
  }
}

📚 Documentation

Available Tools

• Configuration Management
  • configure: Configure the MCP server
  • get-config: Get the current configuration
  • update-config: Update the existing configuration
• Authentication Management
  • auth/login: User login
  • auth/logout: User logout
  • auth/status: Check the authentication status

Development Information

CI/CD Pipeline

The project uses GitHub Actions for continuous integration and delivery:

• Automatically run tests and code checks on pull requests
• Automatically build Docker images on commits to the main branch
• Build multi-architecture images (amd64, arm64)
• Automatically push containers to the GitHub Container Registry

Local Development

Use the provided scripts for local development:

• ./scripts/build-local.sh: Build the project and generate a local Docker image
• ./scripts/run-local.sh: Run the local Docker image and configure your credentials

📄 License

MIT