Confluence MCP Server

🚀 Confluence MCP 服务器

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

🚀 快速开始

Confluence MCP 服务器可帮助你轻松访问 Confluence API。下面为你介绍其使用步骤：

1. 完成安装与设置（详见📦 安装指南）。
2. 启动服务器（详见运行部分）。
3. 调用相应的 API 端点进行操作（详见端点部分）。

✨ 主要特性

• 支持查看所有 Confluence 空间。
• 可查看特定空间中的所有页面。
• 能通过页面 ID 查看特定页面信息。
• 支持创建新页面。
• 可更新现有页面。

📦 安装指南

先决条件

• 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

💻 使用示例

基础用法

以下是使用 GET /api/spaces 端点获取所有空间的示例：

curl http://localhost:3000/api/spaces

高级用法

以下是使用 POST /api/pages 端点创建新页面的示例：

curl -X POST -H "Content-Type: application/json" -d '{
    "title": "New Page",
    "body": "This is a new page."
}' http://localhost:3000/api/pages

📚 详细文档

端点

以下是 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 服务器之间的通信加密。
• 安全管理个人访问令牌，并定期更新。
• 在生产环境中，建议添加适当的认证机制以防止对代理服务器的未授权访问。

🔧 技术细节

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

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

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

📄 许可证

本项目采用 MIT 许可证。