Confluence

🚀 Confluence MCP Server

A FastMCP-based server that provides seamless integration with the Confluence REST API, enabling programmatic access to Confluence spaces, pages, and content search capabilities.

🚀 Quick Start

The Confluence MCP Server offers a seamless way to interact with Confluence's REST API. Before you start, make sure you meet the system requirements and follow the installation steps.

✨ Features

• Space Management: List and filter Confluence spaces.
• Page Operations: Retrieve and manage page content.
• Search Functionality: Perform CQL (Confluence Query Language) searches.
• Space Navigation: List all pages within a specific space.
• Authentication: Secure access based on API tokens.

📦 System Requirements

• Python 3.8+
• pip (Python package manager)
• A valid Confluence instance with API access
• A valid Confluence API token

📦 Installation

Automatic Installation via Smithery

Automatically install the confluence-mcp-server for Claude Desktop through Smithery:

npx -y @smithery/cli install @MahithChigurupati/confluence-mcp-server --client claude

Manual Installation

1. Clone the repository:

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

2. Install dependencies:

   pip install -r requirements.txt
   

3. Start the server:

   python server.py
   

📚 Configuration

1. Create a .env file and add the following content:

   CONFLUENCE_BASE_URL=your_confluence_url
   USERNAME=your_atlassian_email
   API_TOKEN=your_api_token
   

2. Example of setting environment variables:

   export CONFLUENCE_BASE_URL="https://yourcompany.atlassian.net/wiki"
   export USERNAME="user@example.com"
   export API_TOKEN="your_api_token_here"
   

💻 Usage Examples

Starting the Server

python server.py

API Method Examples

• Get a list of spaces:

  response = requests.get("http://localhost:5000/api/confluence/spaces")
  

• Create a new page:

  data = {
      "title": "New Page",
      "parent_id": "12345"
  }
  response = requests.post("http://localhost:5000/api/confluence/pages", json=data)
  

📚 Integration

Claude Desktop Configuration Example

{
    "server_url": "http://localhost:5000",
    "api_key": "your_api_key_here"
}

Cursor Configuration Example

{
    "confluence_server": "https://yourcompany.atlassian.net/wiki",
    "username": "user@example.com",
    "api_token": "your_api_token_here"
}

🔧 Error Handling

Common error codes and their meanings:

• 401: Invalid API token or credentials.
• 403: Insufficient permissions.
• 404: Resource not found.
• 429: Rate limit exceeded.

🔧 Troubleshooting

1. Connection Issues:
   • Verify the format of CONFLUENCE_BASE_URL.
   • Check network connectivity.
   • Confirm the validity of the API token.
2. Authentication Errors:
   • Ensure that the USERNAME matches the Atlassian account email.
   • Verify that the API_TOKEN is correctly pasted.
   • Check for special characters in the .env file.
3. Permission Problems:
   • Confirm that the user has the required Confluence permissions.
   • Verify space and page access permissions.

📚 Support

If you need to report an issue or request a feature, please create an issue in the repository's issue tracker.

📄 License

This project is licensed under the MIT License. See the LICENSE file for full details.