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，可以實現對項目、票務和評論的全面管理，滿足常見的需求。