Minhoyoodev Confluence MCP Server

🚀 Confluence MCP 服务器

Confluence MCP 服务器是一个用于访问 Confluence API 的模型上下文协议（Model Context Protocol）服务器系统。它借助个人访问令牌与 Confluence 进行通信，并在 VPN 区域内充当访问 Confluence API 的中介服务器。

🚀 快速开始

Confluence MCP 服务器可帮助您方便地访问 Confluence API，实现对 Confluence 空间的多种操作。以下是使用该系统的简单步骤：

1. 完成安装与设置（具体步骤见“📦 安装指南”）。
2. 启动服务器：npm start。
3. 通过提供的端点对 Confluence 空间进行操作（具体端点信息见“📚 详细文档”）。

✨ 主要特性

• 查看所有 Confluence 空间：可获取 Confluence 中所有空间的列表。
• 查看特定空间的详细信息：根据空间 ID 获取指定空间的详细内容。
• 创建新空间：可以在 Confluence 中创建新的空间。
• 更新现有空间：对已有的空间信息进行修改。
• 删除指定空间：删除不需要的空间。

📦 安装指南

所需组件

• Node.js（建议版本 14 或更高）
• npm（Node 包管理器）

安装步骤

1. 克隆此仓库：

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

2. 安装依赖项：

   npm install
   

3. 创建 env 文件：
   • 在项目根目录下创建一个名为 .env 的文件。
   • 添加以下内容（根据实际情况修改）：

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

4. 启动服务器：

   npm start
   

📚 详细文档

系统架构

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

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

这种架构设计是为了解决 VPN 区域问题。MCP 服务器在 VPN 内部运行以访问 Confluence API，而代理服务器在可外部访问的环境中运行。

端点

获取所有空间

• 请求方法：GET
• 路径：/api/spaces
• 描述：返回 Confluence 中的所有空间。

获取特定空间

• 请求方法：GET
• 路径：/api/spaces/{spaceId}
• 描述：返回指定空间的详细信息。

创建新空间

• 请求方法：POST
• 路径：/api/spaces
• 描述：创建一个新的 Confluence 空间。

更新现有空间

• 请求方法：PUT
• 路径：/api/spaces/{spaceId}
• 描述：更新指定空间的详细信息。

删除指定空间

• 请求方法：DELETE
• 路径：/api/spaces/{spaceId}
• 描述：删除指定的空间。

运行

启动服务器

npm start

停止服务器

npm stop

测试

执行所有测试

bun test

运行特定测试

bun test src/test/getSpaces.test.ts

部署配置

推荐生产配置

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

安全注意事项

• 建议在 MCP 服务器和代理服务器之间使用 HTTPS 进行通信，以确保数据安全。
• 定期更新个人访问令牌，并确保其存储安全。
• 在生产环境中，建议添加适当的身份验证机制，防止未经授权的访问。

问题解决

常见问题

1. 无法连接到 Confluence 服务器
   • 检查 .env 文件中的 CONFLUENCE_BASE_URL 是否正确。
   • 确保个人访问令牌有效且格式正确。
   • 检查网络设置，确保没有防火墙或代理阻止连接。
2. MCP 服务器与代理服务器之间的通信问题
   • 确保 MCP_SERVER_URL 设置正确。
   • 检查两台服务器之间的网络连接是否正常。