Confluence MCP Server

🚀 Confluence MCP Server

A Model Context Protocol server system for accessing the Confluence API. It uses personal access tokens to communicate with Confluence and acts as an intermediate server for accessing the Confluence API within the VPN area.

🚀 Quick Start

The Confluence MCP Server is a system designed to access the Confluence API. It communicates with Confluence using personal access tokens and serves as an intermediate server within the VPN area.

✨ Features

• View all Confluence spaces.
• View all pages in a specific space.
• View specific page information by page ID.
• Create new pages.
• Update existing pages.

📦 Installation

Prerequisites

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

Installation Steps

# Clone the repository
git clone https://github.com/your-repository.git
cd your-repository

# Install dependencies
bun install

Configuration

1. Copy the .env.example file to .env.
2. Fill in the environment variables in the configuration file as required.

cp .env.example .env

💻 Usage Examples

Basic Usage

# Start in development mode
bun dev

# Start in production mode
bun run

Advanced Usage

# Execute all tests
bun test

# Run specific tests
bun test src/test/getSpaces.test.ts

📚 Documentation

System Composition

The project consists of two servers:

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

This architecture is designed to solve the VPN area problem. The MCP server runs inside the VPN to access the Confluence API, while the proxy server runs in an externally accessible environment.

Endpoints

The following are the main API endpoints of the MCP server:

• GET /api/spaces - Get all spaces.
• POST /api/pages - Create a new page.
• PUT /api/pages/:id - Update an existing page.
• DELETE /api/pages/:id - Delete a page.

Troubleshooting

Common Issues

1. Unable to connect to the Confluence server
   • Check the CONFLUENCE_BASE_URL in the .env file.
   • Ensure that the personal access token is valid and correct.
   • Check the firewall settings to confirm that you can access the Confluence server.
   • Contact the network administrator to confirm access permissions.
2. Communication failure between the MCP server and the proxy server
   • Check if the MCP_SERVER_URL setting is correct.
   • Ensure that the network connection between the two servers is smooth.

Deployment Configuration

Recommended Deployment Configuration

In a production environment, it is recommended to adopt the following deployment architecture:

1. MCP Server: Deployed inside the VPN or in a network that can access the Confluence server.
2. Proxy Server: Deployed in a network that can be accessed by the MCP client.

Security Considerations

• It is recommended to use HTTPS to encrypt the communication between the proxy server and the MCP server.
• Manage personal access tokens securely and update them regularly.
• In a production environment, it is recommended to add appropriate authentication mechanisms to prevent unauthorized access to the proxy server.

📄 License

MIT