Jira MCP Server

Jira MCP Server

一组用于通过模型上下文协议（MCP）与 Jira 交互的工具，提供 Jira 核心功能，以及统一的引导式问题创建与更新向导。

安装

要将其安装到客户端：

{
  "mcpServers": {
    "JiraMCP_Published": {
      "command": "npx",
      "args": [
        "@timbreeding/jira-mcp-server@latest",
        "--jira-base-url=https://example.atlassian.net",
        "[email protected]",
        "--jira-api-token=<your jira token>"
      ],
      "env": {
        "DEBUG": "true",
        "LOG_FILE_PATH": "" // Some full path. If blank, it will not write logs to a file.
      }
    }
  }
}

用法

...

配置

环境变量

在本地运行时，可以将 DEBUG 和 LOG_FILE_PATH 放入 .env 中。

可用工具

此应用通过模型上下文协议提供以下工具：

Jira 核心工具

• getJiraIssue：根据 Jira 问题键获取问题。
• analyzeJiraIssue：对 Jira 问题进行全面分析。
• jiraGet：从任意 Jira API GET 端点获取数据。
• getIssuesByJql：使用 JQL 查询搜索 Jira 问题。

问题创建向导工具

这些工具提供分步引导流程，用于创建新的 Jira 问题。向导会在整个创建流程中维护状态，通常包含以下阶段：启动流程、选择项目（getProjects）、选择问题类型（getIssueTypes）、获取并填写所需字段（getFields、updateFields）、可选地分析问题详情，最后确认并创建问题（createIssue）。使用 getState 和 getStatus 监控进度，使用 resetState 重新开始。

• issueCreation_getState：获取向导当前的内部状态。
• issueCreation_getStatus：获取向导的高级状态。
• issueCreation_initiateState：初始化新的向导状态。
• issueCreation_resetState：重置向导状态。
• issueCreation_updateState：更新向导状态（项目、问题类型、字段、步骤）。
• issueCreation_createIssue：使用向导状态创建 Jira 问题。
• issueCreation_getProjects：获取可用的 Jira 项目。
• issueCreation_getIssueTypes：获取所选项目的可用问题类型。
• issueCreation_getFields：获取所选项目和问题类型所需的字段。
• issueCreation_updateFields：更新向导状态中的特定字段值。
• issueCreation_setAnalysisComplete：设置分析完成标记。
• issueCreation_setUserConfirmation：在创建前设置用户确认标记。
• issueCreation_analyzeIssue：在向导上下文中分析问题详情。

问题更新向导工具（统一更新工作流）

这些工具提供统一、可靠的机制，用于更新任何 Jira 问题，无论是新创建的问题还是已有问题。现在，所有更新都使用单一且一致的工作流：

• issueUpdateWizard_loadIssueIntoState：根据问题键获取 Jira 问题，并将其加载到状态管理器中，以用于统一更新工作流。
• issueUpdateWizard_updateIssueFromState：使用当前状态（字段、项目、类型等）更新已加载的问题。

核心原则：

• 所有问题更新（新问题或已有问题）都遵循相同模式：将问题加载到状态中、修改字段，然后通过 API 更新。
• 新问题与已有问题的更新之间没有代码重复。
• 错误处理精简、明确且可靠。
• 更新操作的单元测试覆盖率为 100%。

开发

运行测试

Jest 已配置用于测试。运行测试套件：

npm test

代码质量检查

要同时运行类型检查、代码检查和测试：

npm run check-codebase

使用 MCP Inspector 运行

在本地开发和测试时，可以使用模型上下文协议 Inspector 启动应用，并通过 -e 标志传入所需的环境变量：

npx @modelcontextprotocol/inspector -e JIRA_BASE_URL=https://your-domain.atlassian.net -e [email protected] -e JIRA_API_TOKEN=your-api-token -e DEBUG=true node build/index.js

（如果使用 build/index.js，请确保已先构建项目。）

许可证

本项目采用 MIT License 许可协议，详情请参阅 LICENSE 文件。