使用说明

项目简介

本项目 'Jira & Confluence MCP Server' 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为LLM（大型语言模型）客户端提供访问和操作 Jira 和 Confluence 数据的能力。通过此服务器，LLM可以利用工具函数搜索、创建和获取Jira issue和Confluence page，从而扩展LLM在知识管理和项目管理领域的应用场景。

主要功能点

Jira 集成:
- 搜索 Jira issue: 允许LLM根据JQL查询语言搜索Jira issue。
- 创建 Jira issue: 支持LLM创建新的Jira issue，例如Bug、Task等。
Confluence 集成:
- 搜索 Confluence page: 允许LLM根据关键词在Confluence中搜索page。
- 获取 Confluence page 内容: 支持LLM获取指定Confluence page的完整内容。
- 批量获取 Confluence page 内容: 允许LLM批量获取多个Confluence page的内容，优化数据访问效率。
- 创建 Confluence page: 支持LLM在指定的Confluence space下创建新的page。
MCP 协议支持:
- 实现了 MCP 协议的 'ListToolsRequest', 'CallToolRequest', 'ListResourcesRequest', 'ReadResourceRequest' 等核心请求处理。
- 通过标准 JSON-RPC 协议与 MCP 客户端通信。
- 使用 Stdio 作为默认的传输协议，易于集成和部署。

安装步骤

克隆仓库

git clone https://github.com/mshinde-jsq/mcp-servers.git

进入 'jira-confluence-server' 目录

cd mcp-servers/jira-confluence-server

安装依赖
```
npm install
```
配置环境变量
- 复制 '.env.example' 文件并重命名为 '.env'。
- 根据 '.env' 文件中的说明，填写你的 Jira 和 Confluence 的 Base URL 和 Token。你需要拥有 Jira 和 Confluence 的有效账号和 API Token。
构建项目
```
npm run build
```

服务器配置

MCP 客户端需要配置以下 JSON 信息才能连接到 'jira-confluence-server'：

{
  "serverName": "jira-confluence-server",  // 服务器名称，可以自定义
  "command": "node",                     // 启动服务器的命令，这里使用 Node.js
  "args": ["dist/index.js"]             // 启动命令的参数，指向编译后的服务器入口文件
}

配置参数说明:

'serverName': MCP 服务器的名称，客户端用以识别和管理连接。
'command': 运行服务器端程序的命令。由于本项目是 Node.js 应用，所以使用 'node' 命令。
'args': 传递给 'command' 的参数，指定了服务器程序入口点 'dist/index.js'。 'dist/index.js' 是执行 'npm run build' 命令后生成的 JavaScript 文件。

基本使用方法

启动服务器 在 'jira-confluence-server' 目录下，执行以下命令启动服务器：
```
npm start
```
服务器将通过 Stdio 监听 MCP 客户端的请求。
配置 MCP 客户端 在你的 MCP 客户端应用中，按照客户端的要求配置服务器连接信息，使用上面提供的 '服务器配置' JSON。
通过 MCP 客户端与服务器交互 客户端连接成功后，你可以通过客户端发送 MCP 请求，例如：
- 使用 'ListToolsRequest' 获取可用的工具列表 (Jira 和 Confluence 的各种操作)。
- 使用 'CallToolRequest' 调用具体的工具，例如 'jira_search_issues' 或 'confluence_create_page'，并传递相应的参数。
- 使用 'ListResourcesRequest' 获取可用的资源列表 (Jira Issues, Confluence Pages)。
- 使用 'ReadResourceRequest' 读取资源内容，例如获取最新的 Jira Issues 列表。
具体请求和参数格式请参考 Model Context Protocol 的官方文档和客户端 SDK 的使用说明。

关键词