项目简介

Confluence MCP服务器是一个基于Model Context Protocol (MCP) 的应用后端,它允许大型语言模型(LLM)通过结构化的工具调用与Confluence Data Center进行交互,实现内容的搜索、获取、创建、更新和删除等操作。

主要功能点

  • 执行Confluence Query Language (CQL) 查询来搜索页面。
  • 根据页面ID获取页面摘要信息。
  • 根据页面ID获取包含完整正文(存储格式)的页面内容。
  • 根据空间键查找该空间下的页面列表。
  • 根据页面标题和空间键查找特定页面。
  • 在指定空间创建新页面,支持指定父页面。
  • 更新现有页面的内容、标题或空间。
  • 根据页面ID删除页面。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/tqiqbal/mcp-confluence-server.git
  2. 进入项目目录:
    cd mcp-confluence-server
  3. 安装依赖:
    pip install -r requirements.txt

服务器配置

Confluence API 配置

在项目根目录创建 '.env' 文件,配置连接你的Confluence实例所需的认证信息和API地址:

CONFLUENCE_API_BASE=http://localhost:8090/rest/api # Confluence REST API基础URL,请修改为你的实际地址
CONFLUENCE_USERNAME=your_username # 连接Confluence的用户名
CONFLUENCE_PASSWORD=your_password # 连接Confluence的密码

请根据你的Confluence环境修改这些值。

MCP客户端连接配置

MCP客户端(如'mcp cli'工具或支持MCP的LLM应用,如Claude Desktop)需要配置如何启动此MCP服务器进程并与其通信。你需要向客户端提供以下信息:

  • 服务器名称 (Server Name): 'confluence'
  • 启动命令 (Command): 'python' (用于执行Python脚本的可执行文件)
  • 命令参数 (Args): '["confluence.py"]' (服务器脚本文件的名称)

客户端会根据这些信息来启动并连接到'confluence.py'进程。具体配置格式取决于你使用的MCP客户端工具。

基本使用方法

服务器配置完成后,你可以通过支持Model Context Protocol的LLM客户端连接到此服务器。LLM将能够识别并调用服务器提供的Confluence工具。

LLM客户端可以根据用户的自然语言指令,自动调用相应的工具来完成与Confluence的交互。例如,你可以尝试使用以下指令(具体支持程度取决于LLM客户端的理解和工具调用能力):

  • "在我的Confluence空间的 'DOCS' 空间中查找关于 '项目计划' 的页面"
  • "获取ID为 '123456' 的那篇Confluence页面的完整内容"
  • "在 'TEAM' 空间创建一个标题为 '每周例会纪要' 的新页面,内容是今天的会议讨论结果"

开发者可以使用'mcp dev confluence.py'命令在开发模式下运行服务器,并利用MCP Inspector UI进行工具测试和调试。

信息

分类

生产力应用