Jira MCP Server for Cursor

🚀 使用REST API管理Jira tickets的完整指南

本指南详细介绍了如何使用REST API对Jira中的项目、票务和评论进行全面管理，涵盖创建、更新、删除等常见操作。

🚀 快速开始

本部分将详细介绍各个API的使用方法，包括请求方法、请求路径、请求参数和响应示例。

💻 使用示例

获取票务列表

功能描述

此API用于获取指定项目下的所有票务。

请求方法

GET

请求路径

/tickets?projectId={ projectId }

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | projectId | String | 是 | 项目ID |

响应示例

[
  {
    "id": "TICKET-001",
    "title": "问题描述",
    "status": "未解决",
    "assignee": "张三",
    "description": "详细的问题描述..."
  },
  ...
]

创建新票务

功能描述

此API用于创建新的票务。

请求方法

POST

请求路径

/tickets

请求体参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | title | String | 是 | 票务标题 | | description | String | 是 | 票务描述 | | projectId | String | 是 | 项目ID | | issueType | String | 是 | 票务类型（例如：问题、任务） |

响应示例

{
  "message": "票务创建成功",
  "ticketId": "TICKET-001"
}

更新现有票务

功能描述

此API用于更新指定ID的票务。

请求方法

PUT

请求路径

/tickets/{ ticketId }

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | ticketId | String | 是 | 票务ID |

请求体参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | title | String | 否 | 票务标题 | | description | String | 否 | 票务描述 | | assignee | String | 否 | 负责人 | | status | String | 否 | 票务状态（例如：未解决、已解决） |

响应示例

{
  "message": "票务更新成功"
}

删除指定票务

功能描述

此API用于删除指定ID的票务。

请求方法

DELETE

请求路径

/tickets/{ ticketId }

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | ticketId | String | 是 | 票务ID |

响应示例

{
  "message": "票务删除成功"
}

获取单个票务详情

功能描述

此API用于获取指定ID的票务详细信息。

请求方法

GET

请求路径

/tickets/{ ticketId }

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | ticketId | String | 是 | 票务ID |

响应示例

{
  "id": "TICKET-001",
  "title": "问题描述",
  "description": "详细的问题描述...",
  "assignee": "张三",
  "status": "未解决"
}

获取所有项目列表

功能描述

此API用于获取所有可用的项目。

请求方法

GET

请求路径

/projects

响应示例

[
  {
    "id": "PROJECT-001",
    "name": "项目名称",
    "description": "项目的描述..."
  },
  ...
]

创建新项目

功能描述

此API用于创建新的项目。

请求方法

POST

请求路径

/projects

请求体参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | name | String | 是 | 项目名称 | | description | String | 否 | 项目描述 |

响应示例

{
  "message": "项目创建成功",
  "projectId": "PROJECT-001"
}

更新现有项目

功能描述

此API用于更新指定ID的项目。

请求方法

PUT

请求路径

/projects/{ projectId }

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | projectId | String | 是 | 项目ID |

请求体参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | name | String | 否 | 项目名称 | | description | String | 否 | 项目描述 |

响应示例

{
  "message": "项目更新成功"
}

删除指定项目

功能描述

此API用于删除指定ID的项目。

请求方法

DELETE

请求路径

/projects/{ projectId }

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | projectId | String | 是 | 项目ID |

响应示例

{
  "message": "项目删除成功"
}

获取项目下的所有票务

功能描述

此API用于获取指定项目下的所有票务。

请求方法

GET

请求路径

/projects/{ projectId }/tickets

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | projectId | String | 是 | 项目ID |

响应示例

[
  {
    "id": "TICKET-001",
    "title": "问题描述",
    "status": "未解决",
    "assignee": "张三",
    "description": "详细的问题描述..."
  },
  ...
]

获取票务的评论列表

功能描述

此API用于获取指定票务的所有评论。

请求方法

GET

请求路径

/tickets/{ ticketId }/comments

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | ticketId | String | 是 | 票务ID |

响应示例

[
  {
    "id": "COMMENT-001",
    "content": "这是一个评论...",
    "author": "张三",
    "createdAt": "2023-01-01T12:00:00Z"
  },
  ...
]

创建新的票务评论

功能描述

此API用于在指定票务下创建新的评论。

请求方法

POST

请求路径

/tickets/{ ticketId }/comments

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | ticketId | String | 是 | 票务ID |

请求体参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | content | String | 是 | 评论内容 |

响应示例

{
  "message": "评论创建成功",
  "commentId": "COMMENT-001"
}

更新票务评论

功能描述

此API用于更新指定ID的评论。

请求方法

PUT

请求路径

/tickets/{ ticketId }/comments/{ commentId }

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | ticketId | String | 是 | 票务ID | | commentId | String | 是 | 评论ID |

请求体参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | content | String | 是 | 评论内容 |

响应示例

{
  "message": "评论更新成功"
}

删除票务评论

功能描述

此API用于删除指定ID的评论。

请求方法

DELETE

请求路径

/tickets/{ ticketId }/comments/{ commentId }

请求参数

| 参数名称 | 数据类型 | 是否必填 | 描述 | |------------|----------|----------|----------------| | ticketId | String | 是 | 票务ID | | commentId | String | 是 | 评论ID |

响应示例

{
  "message": "评论删除成功"
}

总结

以上是RESTful API设计的完整规范，涵盖了项目的创建、更新、删除以及票务和评论的相关操作。通过这些API，可以实现对项目、票务和评论的全面管理，满足常见的需求。