Confluence MCP Server

🚀 Confluence MCP 服务器

Confluence MCP 服务器是一个用于访问 Confluence API 的模型上下文协议服务器系统。它借助个人访问令牌与 Confluence 进行通信，并在 VPN 区域内充当访问 Confluence API 的中间服务器，为用户提供便捷、安全的 API 访问途径。

🚀 快速开始

Confluence MCP 服务器旨在简化对 Confluence API 的访问，通过独特的架构设计，有效解决了 VPN 区域访问限制问题。以下是快速上手该系统的步骤：

1. 确保满足安装的先决条件，包括安装 Node.js 16.x 或更高版本、Bun 1.0.0 或更高版本。
2. 按照安装步骤克隆存储库并安装依赖项。
3. 完成配置文件的设置，填写必要的环境变量。
4. 根据需求选择开发模式或生产模式启动服务器。

✨ 主要特性

• 多功能 API 支持：提供丰富的 API 端点，可查看所有 Confluence 空间、特定空间中的所有页面，还能通过页面 ID 查看特定页面信息，同时支持创建、更新和删除页面等操作。
• 架构设计合理：由 MCP 服务器和代理服务器组成，MCP 服务器负责与 Confluence API 通信并处理数据，代理服务器在 MCP 客户端和 MCP 服务器之间充当代理角色，有效解决 VPN 区域访问问题。
• 易于部署和配置：提供详细的安装、配置和运行说明，方便用户快速搭建和使用。

📦 安装指南

先决条件

• Node.js 16.x 或更高版本
• Bun 1.0.0 或更高版本

安装步骤

# 克隆存储库
git clone https://github.com/your-repository.git
cd your-repository

# 安装依赖项
bun install

配置

1. 复制 .env.example 文件为 .env
2. 根据要求填写配置文件中的环境变量

cp .env.example .env

💻 使用示例

基础用法

以下是启动服务器的基本命令：

# 开发模式启动
bun dev

# 生产模式启动
bun run

高级用法

通过调用不同的 API 端点，可实现更多功能。例如：

# 获取所有空间
curl -X GET http://your-server/api/spaces

# 创建新页面
curl -X POST http://your-server/api/pages -d '{"title": "New Page", "content": "This is a new page."}'

# 更新现有页面
curl -X PUT http://your-server/api/pages/123 -d '{"title": "Updated Page", "content": "This page has been updated."}'

# 删除页面
curl -X DELETE http://your-server/api/pages/123

📚 详细文档

系统构成

该项目由两台服务器组成：

1. MCP 服务器（server.ts）：负责与 Confluence API 通信并处理数据的主要服务器。
   • 默认端口：3000
   • 提供 RESTful API
   • 处理 MCP 协议
2. 代理服务器（proxyServer.ts）：在 MCP 客户端和 MCP 服务器之间充当代理角色。
   • 默认端口：3001
   • 接收来自 MCP 客户端的请求并转发到主服务器

此架构设计用于解决 VPN 区域问题。MCP 服务器在 VPN 内部运行以访问 Confluence API，而代理服务器则在可外部访问的环境中运行。

端点

以下是 MCP 服务器的主要 API 端点：

• GET /api/spaces - 获取所有空间
• POST /api/pages - 创建新页面
• PUT /api/pages/:id - 更新现有页面
• DELETE /api/pages/:id - 删除页面

问题解决

常见问题

1. 无法连接到 Confluence 服务器
   • 检查 .env 文件中的 CONFLUENCE_BASE_URL
   • 确保个人访问令牌有效且正确
   • 查看防火墙设置以确认可以访问 Confluence 服务器
   • 联系网络管理员确认访问权限
2. MCP 服务器和代理服务器之间通信失败
   • 检查 MCP_SERVER_URL 设置是否正确
   • 确保两台服务器之间的网络连接畅通

测试

# 执行所有测试
bun test

# 运行特定测试
bun test src/test/getSpaces.test.ts

部署配置

推荐部署配置

在生产环境中，建议采用以下部署架构：

1. MCP 服务器：部署在 VPN 内部或能够访问 Confluence 服务器的网络中
2. 代理服务器：部署在 MCP 客户端可以访问的网络中

安全注意事项

• 建议使用 HTTPS 实现代理服务器与 MCP 服务器之间的通信加密。
• 安全管理个人访问令牌，并定期更新。
• 在生产环境中，建议添加适当的认证机制以防止对代理服务器的未授权访问。

📄 许可证

本项目采用 MIT 许可证。