Confluence MCP Server

A Model Context Protocol server system for accessing the Confluence API. It communicates with Confluence using Personal Access Tokens. It acts as an intermediary server for accessing the Confluence API within the VPN zone.

System Configuration

This project consists of two servers:

1. MCP Server (server.ts): The main server that communicates with the Confluence API and processes data.
   • Default port: 3000
   • Providing RESTful API
   • MCP protocol processing
2. Proxy Server (proxyServer.ts): Acts as a proxy between the MCP client and the MCP server.
   • Default port: 3001
   • Receives requests from MCP clients and forwards them to the main server

This architecture is designed to address VPN realm issues. The MCP server runs inside the VPN and accesses the Confluence API, while the proxy server runs in an externally accessible environment.

function

• View a list of all Confluence spaces
• View all pages within a specific space
• Retrieve specific page information by page ID
• Create a new page
• Update existing page

Installation and setup

Prerequisites

• Node.js 16.x or later
• Bun 1.0.0 or later

installation

Setting environment variables

Create a .env file in your project root and add the following:

execution

Development Environment

Production environment

Endpoint

MCP Server Endpoint (default port: 3000)

• POST /mcp - Main endpoint handling MCP requests.
• GET /mcp/tools - List available tools
• GET /api/spaces - List all spaces
• GET /api/spaces/:spaceKey/pages - Retrieve a list of pages in a specific space
• GET /api/pages/:pageId - Retrieve information about a specific page
• POST /api/pages - Create a new page
• PUT /api/pages/:pageId - Update a page
• GET /health - Check server health

Proxy server endpoint (default port: 3001)

• POST /mcp - Receives MCP client request and forwards it to MCP server.
• GET /tools - List available tools
• GET /health - Check proxy server status

Troubleshooting

Troubleshoot VPN zone issues

This project has been split into two servers to address VPN zone issues:

1. The MCP server runs inside the VPN and accesses the Confluence API directly.
2. A proxy server runs in an externally accessible environment and receives requests from MCP clients.

This configuration acts as an intermediary in situations where the MCP client cannot access the Confluence API directly.

Error "Error fetching spaces: Unable to connect"

This error can be caused by the following issues:

1. HTTPS certificate issue : SSL certificate verification is disabled in development environments, but proper certificate setup is required in production environments.
2. Network connectivity issues : This may be due to a firewall or proxy settings preventing you from accessing the Confluence server.
3. Personal Access Token issue : The token may have expired or be in the wrong format.

How to solve

1. Make sure CONFLUENCE_BASE_URL in your .env file is correct.
2. Verify that your Personal Access Token is valid.
3. Check your firewall settings to make sure you have access to your Confluence server.
4. Contact your network administrator to verify access rights.
5. Make sure the connection between the MCP server and the proxy server is set up correctly (set MCP_SERVER_URL ).

test

Distribution Configuration

Recommended distribution configuration

For production environments, we recommend the following deployment configuration:

1. MCP Server : Deployed inside the VPN or on a network that has access to the Confluence server.
2. Proxy Server : Deployed on a network accessible to MCP clients.

Security Considerations

• We recommend that communication between the proxy server and the MCP server be encrypted using HTTPS.
• Keep your Personal Access Token safe and renew it regularly as needed.
• In a production environment, add an appropriate authentication mechanism to prevent unauthorized access to the proxy server.

License

MIT