Confluence MCP Server - A management tool including master and slave servers, solving VPN access issues and integrating Confluence API

Confluence MCP Server

Confluence MCP Server is an intermediary server system that communicates with the Confluence API through Personal Access Tokens. It consists of a main server and a proxy server, solves the VPN regional access problem, and provides space and page management functions.

Knowledge management and memory Developer tools #Confluence proxy #API relay #VPN solution #Page management Local .TypeScript

rating : 2 points

downloads : 5

update time : 2025-04-22

What is Confluence MCP Server?

Confluence MCP Server is a specially designed intermediary service system that allows your applications to access and manipulate Confluence content through simple API calls. The system uses a dual - server architecture to ensure reliable operation even in a VPN - restricted environment.

How to use Confluence MCP Server?

You only need to configure the Personal Access Token and then access Confluence content through simple REST API calls. The system will automatically handle complex network connections and security authentication processes.

Use cases

It is particularly suitable for scenarios where enterprises need to access internal Confluence content from an external network or need to automate the management of a large number of Confluence pages.

Main features

Space managementGet a list of all Confluence spaces and view detailed space information

Page operationsCreate, read, update, and delete Confluence pages

VPN penetrationSolve the VPN access limitation problem through a dual - server architecture

Security authenticationUse Personal Access Tokens for secure communication

Advantages and limitations

Advantages

Solve the VPN access limitation problem and enable cross - network access

Simplify Confluence API calls and provide a more user - friendly interface

The dual - server architecture improves system reliability and security

Support multiple Confluence content operation functions

Limitations

Two server environments need to be maintained

Personal Access Tokens need to be updated regularly

Only support specific versions of the Confluence API

Performance may be affected by network conditions

How to use

Environment preparation

Ensure that Node.js version 16.x or higher and Bun version 1.0.0 or higher are installed

Install dependencies

Clone the repository and install the required dependency packages

Configure environment variables

Create a.env file and set the necessary configuration parameters

Start the service

Start the main server or proxy server as needed

Usage examples

Get all pages in the Marketing department spaceThe marketing team needs to regularly view and update their documents

Create a new product description documentThe product team needs to create a description document for the newly released product

Update the expired policy documentThe human resources department needs to update the company policy document

Frequently Asked Questions

Why do we need two servers?

How to obtain a Personal Access Token?

What should I do if I encounter the 'Unable to connect' error?

Which Confluence versions does the system support?

How to ensure communication security?

Related resources

Confluence official API documentation

Complete reference documentation for the Confluence REST API

Bun.js official website

Official documentation and tutorials for the Bun JavaScript runtime

Node.js download

Official Node.js download page

Personal Access Token management guide

How to create and manage API tokens for your Atlassian account

🚀 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

Copy the .env.example file to .env.
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:

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
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

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.
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:

MCP Server: Deployed inside the VPN or in a network that can access the Confluence server.
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.