Minhoyoodev Confluence MCP Server

🚀 Confluence MCP Server

A Model Context Protocol (MCP) server system for accessing the Confluence API. It uses personal access tokens to communicate with Confluence and acts as an intermediary 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 intermediary server within the VPN area.

✨ Features

• View all Confluence spaces.
• View detailed information about a specific space.
• Create a new space.
• Update an existing space.
• Delete a specified space.

📦 Installation

Required Components

• Node.js (version 14 or higher is recommended).
• npm (Node Package Manager).

Installation Steps

1. Clone this repository:

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

2. Install dependencies:

   npm install
   

3. Create an env file:

   • Create a file named .env in the project root directory.
   • Add the following content (modify according to your actual situation):

     CONFLUENCE_BASE_URL=your_confluence_server_url
     PERSONAL_ACCESS_TOKEN=your_personal_access_token
     MCP_SERVER_URL=http://localhost:3000
     

4. Start the server:

   npm start
   

💻 Usage Examples

Starting the Server

npm start

Stopping the Server

npm stop

API Endpoints

Get All Spaces

• Request Method: GET
• Path: /api/spaces
• Description: Returns all spaces in Confluence.

Get a Specific Space

• Request Method: GET
• Path: /api/spaces/{spaceId}
• Description: Returns detailed information about the specified space.

Create a New Space

• Request Method: POST
• Path: /api/spaces
• Description: Creates a new Confluence space.

Update an Existing Space

• Request Method: PUT
• Path: /api/spaces/{spaceId}
• Description: Updates the detailed information of the specified space.

Delete a Specified Space

• Request Method: DELETE
• Path: /api/spaces/{spaceId}
• Description: Deletes the specified space.

📚 Documentation

System Architecture

The project consists of two servers:

1. MCP Server (server.ts): The main server responsible for communicating with the Confluence API to process data.

   • Default port: 3000
   • Provides RESTful APIs
   • Handles the 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 passes 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.

🔧 Technical Details

Troubleshooting

Common Issues

1. Unable to connect to the Confluence server

   • Check if the CONFLUENCE_BASE_URL in the .env file is correct.
   • Ensure that the personal access token is valid and in the correct format.
   • Check the network settings to ensure that there are no firewalls or proxies blocking the connection.

2. Communication issues between the MCP server and the proxy server

   • Ensure that the MCP_SERVER_URL is set correctly.
   • Check the network connection between the two servers.

Testing

Run All Tests

bun test

Run Specific Tests

bun test src/test/getSpaces.test.ts

Deployment Configuration

Recommended Production Configuration

1. MCP Server: Deploy it inside the VPN or in a network that can access the Confluence server.
2. Proxy Server: Deploy it in a network that allows MCP clients to access.

Security Considerations

• It is recommended to use HTTPS for communication between the MCP server and the proxy server to ensure data security.
• Regularly update the personal access token and ensure its secure storage.
• In a production environment, it is recommended to add appropriate authentication mechanisms to prevent unauthorized access.