Enables interaction with the Atlassian ecosystem by connecting to Confluence Cloud or Server instances for documentation and workspace management.
Provides tools to search for pages, blog posts, and attachments, fetch full page content with HTML-to-Markdown conversion, and list all pages within a specific workspace.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Confluence MCP Serversearch for the project onboarding documentation"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Confluence MCP Server
A Model Context Protocol (MCP) server that bridges Confluence Wiki with Large Language Models, enabling LLMs to search, read, and explore Confluence content seamlessly.
Features
MCP Protocol Compliance: Implements the official Model Context Protocol with stdio communication
Three Core Tools:
search_confluence: Search for pages, blog posts, and attachmentsread_page: Fetch full page content with automatic HTML-to-Markdown conversionlist_space_content: List all pages within a Confluence workspace
Smart Content Conversion: Automatically converts Confluence HTML to clean Markdown for optimal LLM context usage
Robust Error Handling: Gracefully handles authentication (401) and not found (404) errors
Docker Support: Optional containerization for easy deployment
Prerequisites
Python 3.11 or higher
uv (recommended) or pip
Confluence Cloud or Server instance
Confluence API token (generate from your Atlassian account settings)
Docker (optional, for containerized deployment)
Quick Start
1. Clone and Setup
2. Configure Credentials
Create a .env file from the example:
Edit .env with your Confluence credentials:
3. Install Dependencies
Using uv (recommended)
Using pip
4. Test the Server
Option A: Using the built-in host client
Run the host client to test the MCP server:
Option B: Using MCP Inspector (Recommended for Development)
The MCP Inspector is the official testing tool for MCP servers.
Install MCP Inspector:
Configure the server: The Inspector runs directly through npx without requiring installation:
The config should look like:
Launch the Inspector:
This will open a web interface at http://localhost:5173 where you can:
View all available tools
Test each tool with custom inputs
See real-time request/response data
Debug tool execution
Note: You can also use environment variables from .env by modifying the config to load from the file.
For a comprehensive testing guide including troubleshooting and advanced usage, see TESTING.md.
Docker Deployment
The Docker container runs the MCP server with HTTP/SSE transport (Server-Sent Events), making it accessible over the network.
Build the Image
Run the Container
Connect to the Docker Container
Once the container is running, use the host client with the --http flag:
Architecture:
Server Transport: HTTP/SSE (Server-Sent Events over port 8000)
Client Connection: Uses
--httpflag to connect via HTTPBenefits: Can be accessed remotely, scales horizontally, works with load balancers
Architecture
This project implements the Model Context Protocol (MCP), which allows LLMs to interact with external tools and data sources. The server supports two transport modes:
Local Mode (stdio)
Docker Mode (HTTP/SSE)
Transport Options:
stdio: For local development and testing
HTTP/SSE: For containerized deployment, remote access, and production use
API Tools
search_confluence
Search for content across your Confluence instance.
Input:
Output:
read_page
Fetch the full content of a Confluence page, converted to Markdown.
Input:
Output:
list_space_content
List all pages within a specific Confluence space.
Input:
Output:
Development
Project Structure
server.py- MCP server implementation using FastMCPhost.py- MCP client for testingpyproject.toml- Project metadata and dependencies (uv configuration)requirements.txt- Python dependencies (for pip compatibility)Dockerfile- Container configuration.env.example- Environment variables templatemcp-config.example.json- MCP Inspector configuration templatefunc_req.md- Functional requirements specificationTESTING.md- Comprehensive testing guide with troubleshooting
Common uv Commands
Requirements Alignment
This implementation follows the requirements specified in func_req.md:
✅ REQ-01: Confluence API integration with search, read, and list tools
✅ REQ-01: HTML to Markdown conversion for LLM context efficiency
✅ REQ-01: Error handling for 401 and 404 responses
✅ REQ-02: Docker containerization with stdio communication
✅ REQ-02: Environment-based configuration
✅ REQ-03: Simple MCP host client with CLI interface
Contributing
This project follows PEP 8 coding conventions. When contributing:
Ensure all three tools maintain backward compatibility
Add appropriate error handling for new API calls
Update documentation for new features
Test with both local and Docker deployment
License
[Your License Here]