项目简介

Jira上下文模型协议（MCP）是一个帮助开发者更高效地与Jira集成的工具。通过这个项目，你可以在代码编辑器中直接获取和操作Jira任务，无需在多个窗口之间切换。

主要功能

• 直接从你的IDE获取Jira任务
• 按类型、项目或分配情况过滤任务
• 获取单个任务的详细信息
• 查看最近的任务更新
• 支持命令行界面（CLI）
• 自动生成文档和示例

安装指南

环境要求

• Node.js 14.0或更高版本
• npm 5.0或更高版本

安装步骤

1. 克隆仓库：

   git clone https://github.com/rahulthedevil/jira-mcp.git
   cd jira-mcp
   

2. 安装依赖：

   npm install
   

3. 启动服务：

   npm start
   

4. 或使用命令行工具：

   npm run cli
   

配置

在项目根目录创建一个.env文件，并添加以下内容：

JIRA_API_TOKEN=你的Jira令牌
JIRA_ACCOUNT_EMAIL=你的Jira账户邮箱

快速上手

启动服务后，你可以在代码编辑器中使用以下命令：

• 获取所有任务：

  /list_issues
  

• 按类型过滤任务：

  /get_issues_by_type issueType:缺陷
  

• 获取单个任务详情：

  /get_issue issueKey:项目编号
  

开发指南

项目结构

src/
├── services/        # Jira API调用服务
├── types/          # TypeScript类型定义
├── utils/          # 工具函数
└── server.ts       # MCP服务器实现

添加新功能

1. 在server.ts中注册新的工具：

   import { Tool } from '@rahulthedevil/mcp-core'
   
   const newTool = new Tool({
     name: '新工具',
     description: '描述你的新工具',
     args: {
       param1: { type: 'string', required: true, description: '参数1' },
     },
   })
   
   registerTools([newTool])
   

许可证

MIT许可

作者

Rahul Dey - @rahulthedevil