关键词

AtlassianConfluenceJira集成工具

使用说明

项目简介

MCP Atlassian Integration Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 AI 智能体提供与 Atlassian 产品（Confluence 和 Jira）交互的标准化接口。通过此服务器，AI 智能体可以利用预定义的工具来访问和操作 Confluence 和 Jira 中的数据，从而扩展其功能和应用场景。

主要功能点

  • Confluence 工具:
    • 'search-confluence': 在 Confluence 中使用 CQL (Confluence Query Language) 查询内容。
    • 'get-confluence-space': 获取指定 Confluence 空间的信息。
    • 'get-confluence-content': 根据 ID 获取指定的 Confluence 内容。
    • 'get-confluence-pages': 获取指定 Confluence 空间下的所有页面。
  • Jira 工具:
    • 'search-jira-issues': 在 Jira 中使用 JQL (Jira Query Language) 查询问题。
    • 'get-jira-issue': 根据 Key 获取指定的 Jira 问题详情。
    • 'get-jira-projects': 获取所有 Jira 项目列表。
    • 'get-jira-project': 根据 Key 获取指定的 Jira 项目信息。
    • 'get-jira-issue-types': 获取所有 Jira 问题类型。

安装步骤

  1. 克隆仓库

    git clone https://github.com/samwang0723/mcp-atlassian.git
cd mcp-atlassian

  2. 安装依赖 使用 npm 或 make 命令安装项目依赖：

    npm install
# 或
make install

  3. 配置环境变量 在项目根目录下创建 '.env' 文件，并填入您的 Atlassian 产品连接信息：

    ATLASSIAN_HOST=https://your-domain.atlassian.net  # 您的 Atlassian 主机地址
[email protected]        # 您的 Atlassian 邮箱
ATLASSIAN_API_TOKEN=your-api-token             # 您的 Atlassian API Token

    请务必替换上述占位符为您真实的 Atlassian 域名、邮箱和 API Token。 获取 API Token 的方法请参考 Atlassian 官方文档。

服务器配置

以下为 MCP 客户端连接此 MCP 服务器时所需的配置信息（JSON 格式）：

{
  "serverName": "mcp-atlassian",  // 服务器名称，与仓库 'package.json' 中的 'name' 字段保持一致
  "command": "npm",             // 启动服务器的命令，这里使用 npm
  "args": ["start"]              // 启动命令的参数，'npm start' 实际执行 'npm run start'，对应 'package.json' 中的 'start' 脚本
}

配置说明:

  • 'serverName': MCP 服务器的名称，用于客户端识别。
  • 'command': 运行 MCP 服务器的命令，通常为 Node.js 环境下的 'npm' 或 'node'。
  • 'args': 传递给 'command' 的参数，用于启动服务器。根据 'package.json' 中的 'scripts' 配置，'npm start' 会执行服务器启动脚本。

基本使用方法

  1. 启动服务器 在项目根目录下，使用 npm 或 make 命令启动 MCP 服务器：

    npm start
# 或
make start

    服务器启动后，将监听标准输入 (stdin) 并通过标准输出 (stdout) 响应 MCP 客户端的请求。

  2. MCP 客户端连接 配置您的 MCP 客户端，使其使用上述 服务器配置 信息连接到正在运行的 MCP Atlassian Integration Server。客户端将通过 JSON-RPC 协议与服务器通信，调用预定义的工具来操作 Confluence 和 Jira。

  3. 调用工具 客户端可以发送符合 MCP 协议的 JSON-RPC 请求来调用服务器提供的工具，例如 'search-confluence' 或 'get-jira-issue'。具体的工具调用方法和参数请参考 MCP 协议文档和工具定义。

注意:

  • 确保您的 Atlassian 账户拥有访问 Confluence 和 Jira 的权限。
  • API Token 需要在 Atlassian 后台生成并配置到 '.env' 文件中。
  • 服务器默认使用 Stdio 传输协议进行通信。

信息

分类

开发者工具

访问项目