使用说明
项目简介
Jira Cloud MCP 服务器是一个允许大型语言模型 (LLM) 通过 Model Context Protocol (MCP) 与 Jira Cloud 实例集成的后端服务。它提供了一系列工具,使 LLM 能够执行诸如创建、检索、更新和搜索 Jira 问题,以及管理项目和看板等操作。这个服务器充当了 LLM 和 Jira Cloud 之间的桥梁,使得 LLM 可以利用 Jira 中的信息和功能来增强其自身的能力。
主要功能点
- 问题管理: 创建、检索、更新和评论 Jira 问题。
- 搜索功能: 使用 JQL (Jira Query Language) 进行高级问题搜索和过滤。
- 项目与看板管理: 列出和管理 Jira 项目、看板和迭代。
- 可扩展性: 支持自定义字段和工作流,可以根据 Jira Cloud 实例的配置进行调整。
安装步骤
- 环境准备: 确保您的机器上已安装 Docker。
- 配置 MCP 客户端: 您需要配置您的 MCP 客户端,将 Jira Cloud MCP 服务器添加到可用的 MCP 服务器列表中。
服务器配置
以下 JSON 配置信息需要添加到您的 MCP 客户端配置中,以便客户端能够连接到 Jira Cloud MCP 服务器。请注意,您不需要修改或运行以下代码,而是将这段配置信息复制到您的 MCP 客户端的配置文件中。
{ "mcpServers": { "jira-cloud": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "JIRA_EMAIL", // Jira 邮箱账号,用于API认证 "-e", "JIRA_HOST", // Jira Cloud 域名,例如 your-team.atlassian.net "-e", "JIRA_API_TOKEN", // Jira API Token,用于API认证 "ghcr.io/aaronsb/jira-cloud:latest" // Docker 镜像名称 ], "env": { "JIRA_API_TOKEN": "your-api-token", // 请替换为您的 Jira API Token "JIRA_EMAIL": "your-email", // 请替换为您的 Jira 邮箱账号 "JIRA_HOST": "your-team.atlassian.net" // 请替换为您的 Jira Cloud 域名 } } } }
配置参数说明:
- '"server name"': '"jira-cloud"' - 服务器的名称,在 MCP 客户端中用于标识和选择此服务器。
- '"command"': '"docker"' - 运行服务器的命令,这里使用 Docker 运行。
- '"args"': Docker 运行命令的参数列表:
- '"run"': Docker 运行命令。
- '"-i"': 保持标准输入 (STDIN) 打开,即使未连接。
- '"--rm"': 容器退出后自动删除容器。
- '"-e", "JIRA_EMAIL"': 设置环境变量 'JIRA_EMAIL',用于传递 Jira 邮箱账号。
- '"-e", "JIRA_HOST"': 设置环境变量 'JIRA_HOST',用于传递 Jira Cloud 域名。
- '"-e", "JIRA_API_TOKEN"': 设置环境变量 'JIRA_API_TOKEN',用于传递 Jira API Token。
- '"ghcr.io/aaronsb/jira-cloud:latest"': Docker 镜像的名称,指定要运行的 Jira Cloud MCP 服务器镜像。
- '"env"': 环境变量配置,请务必根据您的 Jira Cloud 实例信息修改以下参数:
- '"JIRA_API_TOKEN"': [请替换] 您的 Jira API Token。您需要在您的 Atlassian 账户中生成 API Token。
- '"JIRA_EMAIL"': [请替换] 您的 Jira 邮箱账号,用于 API 认证。
- '"JIRA_HOST"': [请替换] 您的 Jira Cloud 域名,例如 'your-team.atlassian.net'。请确保替换为您自己的 Jira Cloud 域名。
基本使用方法
- 启动 MCP 客户端: 启动您配置了 Jira Cloud MCP 服务器的 MCP 客户端。
- 选择服务器: 在 MCP 客户端中选择名为 "jira-cloud" 的服务器。
- 调用工具: 使用 MCP 客户端提供的界面或指令,调用 Jira Cloud MCP 服务器提供的工具,例如:
- 'list_jira_projects': 列出所有 Jira 项目。
- 'get_jira_issue': 获取指定 Jira issue key 的基本信息,例如 '{"issueKey": "PROJ-123"}'。
- 'search_jira_issues': 使用 JQL 查询 Jira issue,例如 '{"jql": "project = PROJ AND status = Open"}'。
- 更多工具请参考 API Reference 文档(如果您的 MCP 客户端可以访问)。
- 查看结果: MCP 客户端会显示服务器返回的 JSON 格式的结果,您可以根据需要解析和使用这些信息。
注意: 首次使用前,请务必正确配置 'env' 中的 'JIRA_API_TOKEN', 'JIRA_EMAIL', 和 'JIRA_HOST',确保 MCP 服务器能够成功连接到您的 Jira Cloud 实例。
信息
分类
开发者工具