Confluence MCP 服务器

Confluence API에 접근하기 위한 Model Context Protocol 서버 시스템입니다. Personal Access Token을 사용하여 Confluence와 통신합니다. VPN 영역 내에서 Confluence API에 접근하기 위한 중개 서버 역할을 합니다.

系统构成

该项目由两个服务器构成：

1. MCP 服务器 (server.ts): 与 Confluence API 通信并处理数据的主服务器。

   • 默认端口: 3000
   • 提供 RESTful API
   • 处理 MCP 协议

2. 代理服务器 (proxyServer.ts): 充当 MCP 客户端和 MCP 服务器之间的代理。

   • 默认端口: 3001
   • 接收来自 MCP 客户端的请求并将其传递到主服务器

此结构旨在解决 VPN 区域问题。 MCP 服务器在 VPN 内部运行以访问 Confluence API，而代理服务器在可从外部访问的环境中运行。

功能

• 查询所有 Confluence 空间列表
• 查询特定空间内的所有页面
• 通过页面 ID 查询特定页面信息
• 创建新页面
• 更新现有页面

安装和设置

必备条件

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

安装

# 克隆存储库
git clone https://github.com/yourusername/confluence-mcp-server.git
cd confluence-mcp-server

# 安装依赖项
bun install

环境变量设置

在项目根目录中创建一个 .env 文件并添加以下内容：

PORT=3000
PROXY_PORT=3001
MCP_SERVER_URL=http://localhost:3000
CONFLUENCE_BASE_URL=https://wiki.musinsa.com
PERSONAL_ACCESS_TOKEN=your_personal_access_token
NODE_ENV=development

执行

开发环境

# 运行 MCP 服务器 (与 Confluence API 通信)
bun run dev

# 运行代理服务器 (与 MCP 客户端通信)
bun run dev:proxy

# 运行 MCP 服务器 Stdio 模式 (可选)
bun run dev:stdio

生产环境

# 构建
bun run build

# 运行 MCP 服务器
bun run serve

# 运行代理服务器
bun run serve:proxy

端点

MCP 服务器端点 (默认端口: 3000)

• POST /mcp - 处理 MCP 请求的主端点
• GET /mcp/tools - 查询可用工具列表
• GET /api/spaces - 查询所有空间列表
• GET /api/spaces/:spaceKey/pages - 查询特定空间的页面列表
• GET /api/pages/:pageId - 查询特定页面信息
• POST /api/pages - 创建新页面
• PUT /api/pages/:pageId - 更新页面
• GET /health - 检查服务器状态

代理服务器端点 (默认端口: 3001)

• POST /mcp - 接收 MCP 客户端请求并将其传递到 MCP 服务器
• GET /tools - 查询可用工具列表
• GET /health - 检查代理服务器状态

问题解决

VPN 区域问题解决

此项目已分为两个服务器以解决 VPN 区域问题：

1. MCP 服务器在 VPN 内部运行，以直接访问 Confluence API。
2. 代理服务器在可从外部访问的环境中运行，以接收 MCP 客户端的请求。

此配置充当 MCP 客户端无法直接访问 Confluence API 的情况下的中介。

"Error fetching spaces: Unable to connect" 错误

此错误可能是由以下问题引起的：

1. HTTPS 证书问题: 在开发环境中，SSL 证书验证已禁用，但在生产环境中，需要正确的证书设置。

2. 网络连接问题: 由于防火墙或代理设置，无法访问 Confluence 服务器。

3. Personal Access Token 问题: 令牌可能已过期或格式不正确。

解决方法

1. 验证 .env 文件中的 CONFLUENCE_BASE_URL 是否正确。
2. 验证 Personal Access Token 是否有效。
3. 检查防火墙设置以确保可以访问 Confluence 服务器。
4. 联系网络管理员以验证访问权限。
5. 验证 MCP 服务器和代理服务器之间的连接是否已正确设置 (MCP_SERVER_URL 设置)。

测试

# 运行所有测试
bun test

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

部署配置

推荐部署配置

在生产环境中，建议使用以下部署配置：

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

安全注意事项

• 建议使用 HTTPS 加密代理服务器和 MCP 服务器之间的通信。
• 安全地管理 Personal Access Token，并根据需要定期更新。
• 在生产环境中，添加适当的身份验证机制以防止未经授权访问代理服务器。

许可证

MIT