Jira Insights MCP

🚀 Jira 洞察 MCP 服務器

這是一個用於管理 Jira Insights 資產模式的模型上下文協議 (MCP) 服務器。它提供了對資產模式、對象類型和屬性的增刪改查功能，還支持通過 AQL 查詢進行數據檢索，為 Jira 資產管理提供了強大的支持。

🚀 快速開始

本項目是用於管理 Jira Insights 資產模式的 MCP 服務器。它提供了資產模式、對象類型和屬性的管理功能，還支持通過 AQL 查詢進行數據檢索。

✨ 主要特性

• 資產模式管理：支持創建、讀取、更新和刪除資產模式。
• 對象類型管理：提供對象類型的全量和增量信息，包括屬性擴展。
• 屬性管理：允許獲取單個屬性或多個屬性的詳細信息，並支持按名稱搜索屬性。
• AQL 查詢：通過 AQL 語法進行復雜的數據檢索。

📦 安裝指南

本地開發安裝

1. 克隆代碼庫：

   git clone [倉庫地址]
   cd jira-insight-mcp-server
   

2. 安裝依賴項：

   npm install
   

3. 啟動服務器：

   npm start
   

Docker 部署

1. 構建 Docker 鏡像：

   ./scripts/build-local.sh
   

2. 運行容器：

   ./scripts/run-local.sh
   

💻 使用示例

服務器配置

可以通過環境變量或配置文件來設置以下參數：

• JIRA_API_TOKEN：Jira API 訪問令牌。
• JIRA_HOST_URL：Jira 實例的 URL 地址。

基礎用法

# 設置環境變量並啟動容器
export JIRA_API_TOKEN="your_token_here"
export JIRA_HOST_URL="https://your-jira-instance.atlassian.com"
docker-compose up

📚 詳細文檔

工具集

資產模式管理工具

• 命令：manage_jira_insight_schema
• 功能：
  • 創建新資產模式。
  • 獲取指定 ID 的資產模式詳細信息。
  • 更新現有資產模式。
  • 刪除指定 ID 的資產模式。

對象類型管理工具

• 命令：manage_jira_object_type
• 功能：
  • 獲取所有對象類型的完整或增量信息，支持 expand=attributes 參數。

屬性管理工具

• 命令：manage_jira_attribute
• 功能：
  • 獲取單個屬性的詳細信息。
  • 搜索匹配指定名稱的多個屬性。

資源概覽

計劃改進

高優先級改進

1. 增強錯誤處理：
   • 提供更詳細的錯誤信息，包括具體的問題描述。
   • 增加錯誤修復建議和操作示例。
2. 優化 AQL 查詢功能：
   • 添加查詢驗證和格式化工具。
   • 提供按模式定製的示例查詢。
3. 改進屬性發現機制：
   • 優化屬性獲取性能，增加緩存支持。
   • 改善 expand 參數的處理邏輯。

中等優先級改進

1. 對象模板生成：
   • 根據對象類型自動生成創建模板。
   • 提供佔位符示例和驗證規則。
2. 查詢庫優化：
   • 建立模式相關的查詢示例庫。
   • 實現上下文感知的查詢建議功能。

開發指南

腳本使用

• npm run build：構建 TypeScript 代碼。
• npm run lint：運行 ESLint 檢查代碼風格。
• npm run test：執行單元測試。
• npm run watch：開啟即時代碼監控和自動構建。

故障排除

常見問題

1. AQL 查詢錯誤：
   • 確保使用雙引號包裹含空格的值，例如 Name = "John Doe"。
   • 使用大寫邏輯運算符如 AND、OR。
2. 屬性獲取失敗：
   • 檢查 API 訪問令牌是否有效且權限足夠。
   • 確認對象類型 ID 是否正確。

項目文件

• 配置文件：config/default.json
• 日誌文件：logs/

注意事項

⚠️ 重要提示

修改代碼後需重新構建 Docker 鏡像以生效更改。

💡 使用建議

使用環境變量避免硬編碼敏感信息。

更多詳細信息請參考項目文檔或聯繫開發團隊。