Confluence Integration Server for MCP

This FastMCP-compliant server furnishes robust connectivity to Atlassian Confluence's web services interface, facilitating automated operations across spaces, pages, and content indexing.

Core Capabilities

• Space Administration: Inventory and filter available Confluence content repositories.
• Document Manipulation: Fetch and modify the substance of individual pages.
• Information Retrieval: Execute advanced queries using Confluence Query Language (CQL).
• Structural Traversal: Map the hierarchy of documents within designated spaces.
• Secure Access: Utilizes API token mechanisms for authenticated sessions.

Prerequisites

• Python interpreter, version 3.8 or higher.
• Python's package installer (pip).
• An operational Confluence installation granting REST API permissions.
• A valid, generated Confluence API credential.

Deployment Instructions

Smithery Automated Setup

For streamlined integration within Claude Desktop via Smithery:

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

Manual Installation Workflow

1. Source Code Retrieval bash git clone https://github.com/MahithChigurupati/Confluence-MCP-Server.git cd Confluence-MCP-Server

2. Environment Isolation (Recommended Practice) bash python -m venv server_env source server_env/bin/activate # For Unix-like systems

or

.\server_env\Scripts\activate # For Windows

1. Dependency Resolution bash pip install -r requirements.txt

Configuration Protocol

1. Configuration File Initialization bash cp .env.example .env

2. Setting Environment Variables Edit the .env file with your specifics: plaintext CONFLUENCE_BASE_URL=https://your-domain.atlassian.net/wiki/rest/api USERNAME=your.identity@organization.com API_TOKEN=your-secret-access-token

3. API Token Generation Guide a. Navigate to Atlassian Security Credentials. b. Initiate token creation ('Create API Token'). c. Provide a descriptive label. d. Securely record the output token; it is displayed only once.

Operation Manual

Server Activation

Execute the primary script: bash python confluence.py

Exposed Methods (Asynchronous Calls)

1. Retrieve All Spaces

python results = await list_spaces( query="development", # Optional filter string limit=50, # Optional result quantity cap start=0 # Optional offset for large sets )

2. Fetch Specific Page Payload

python content_data = await get_page_content( page_id="98765", # Mandatory identifier version=1 # Optional revision number )

3. Execute Content Search

python search_hits = await search_content( query="quarterly review agenda", # Mandatory search term space_key="FINANCE", # Optional space scope limit=100, # Optional maximum return count start=0 # Optional starting point )

4. Index Pages Within a Container

python page_list = await list_pages_in_space( space_key="HR_POLICIES", # Mandatory space identifier limit=200, # Optional enumeration limit start=0 # Optional pagination start )

Client Integration Configuration

Claude Desktop Setup

Place this structure into your configuration file:

{ "mcpServers": { "confluence": { "command": "python executable path", "args": ["/full/path/to/Confluence-MCP-Server/confluence.py"] } } }

Location reference: ~/.claude/claude_desktop_config.json (Linux/macOS) or %USERPROFILE%\.claude\config.json (Windows)

Cursor Client Setup

Use the following JSON structure for Cursor integration:

{ "mcpServers": { "confluence": { "command": "python executable path", "args": ["/full/path/to/Confluence-MCP-Server/confluence.py"] } } }

Guidance: Determine Python path via which python. Determine repository root path via pwd inside the cloned directory, appending /confluence.py.

Location reference: ~/.cursor/mcp.json (Linux/macOS) or %USERPROFILE%\.cursor\config.json (Windows)

Incident Reporting Codes

Mapping of common HTTP response codes to issues:

• 401: Authentication failure (incorrect token/credentials).
• 403: Authorization denial (insufficient access rights).
• 404: Target resource was not located.
• 429: Request volume exceeds allowed rate limits.

Diagnostic Procedures

1. Connectivity Failures
2. Validate the endpoint URL structure in CONFLUENCE_BASE_URL.
3. Verify network accessibility to the Confluence host.

4. Reconfirm the operational status of the API credential.

5. Credential Malfunctions

6. Ensure the USERNAME matches the Atlassian login email precisely.
7. Double-check the literal transcription of API_TOKEN.

8. Scrutinize the .env file for extraneous whitespace or hidden characters.

9. Authorization Impediments

10. Confirm the associated user possesses necessary permissions within Confluence.
11. Validate read/write access rights for targeted spaces and documents.

Community Aid

Report bugs or propose enhancements by submitting a formal issue via the project's issue tracking system.

Licensing

Distributed under the MIT License. Full stipulations are detailed in the LICENSE file.