Atlassian

🚀 MCP Atlassian 說明文檔

此MCP服務器允許AI代理通過標準接口與Atlassian產品（包括Confluence和Jira）交互，為開發者提供了便捷的方式來操作Atlassian服務，實現內容搜索、信息獲取等功能。

🚀 快速開始

啟動服務器

# 使用npm啟動
npm start

# 使用make命令
make start

# 使用Docker運行
make docker-run

啟動後，MCP服務器將監聽標準輸入，並在標準輸出上響應請求。

✨ 主要特性

• Confluence：可搜索內容、獲取空間信息、檢索具體頁面。
• Jira：能搜索問題、獲取問題詳情、列出項目等。

📦 安裝指南

標準安裝步驟

1. 克隆倉庫：

   git clone https://github.com/yourusername/mcp-atlassian.git
   cd mcp-atlassian
   

2. 安裝依賴項：

   npm install
   # 或使用make命令
   make install
   

3. 創建根目錄下的.env文件，添加你的Atlassian憑證信息：

   ATLASSIAN_HOST=https://your-domain.atlassian.net
   ATLASSIAN_EMAIL=your-email@example.com
   ATLASSIAN_API_TOKEN=your-api-token
   

Docker安裝步驟

1. 克隆倉庫：

   git clone https://github.com/yourusername/mcp-atlassian.git
   cd mcp-atlassian
   

2. 創建.env文件，如上所述。
3. 使用Docker構建和運行容器：

   # 構建Docker鏡像
   make docker-build
   
   # 運行Docker容器
   make docker-run
   
   # 或使用Docker Compose
   make docker-compose
   

💻 使用示例

可用工具列表

Confluence 工具集

• search-confluence：使用CQL搜索Confluence中的內容
  • 參數：query（字符串）
• get-confluence-space：獲取特定Confluence空間的信息
  • 參數：spaceKey（字符串）
• get-confluence-content：通過ID獲取具體內容
  • 參數：contentId（字符串）
• get-confluence-pages：獲取某空間下的所有頁面
  • 參數：spaceKey（字符串）、limit（數字，可選）

Jira 工具集

• search-jira-issues：使用JQL搜索問題
  • 參數：jql（字符串）、maxResults（數字，可選）
• get-jira-issue：通過關鍵字段獲取特定問題
  • 參數：issueKey（字符串）
• get-jira-projects：獲取所有項目
  • 參數：無
• get-jira-project：通過項目關鍵字段獲取特定項目
  • 參數：projectKey（字符串）
• get-jira-issues：獲取問題列表
  • 參數：無

📚 詳細文檔

開發指南

項目結構

項目的目錄結構如下：

mcp-atlassian/
├── src/          # 源代碼目錄
│   ├── confluence.js    # Confluence相關功能實現
│   └── jira.js         # Jira相關功能實現
├── Makefile        # 工程構建文件
└── .env.example    # .env文件示例

構建與測試

1. 使用npm進行開發：

   npm run dev
   

2. 測試項目：

   npm test
   

3. 打包項目：

   npm run build
   

Makefile 使用說明

Makefile 提供了以下命令：

• make install：安裝依賴項
• make dev：啟動開發服務器
• make build：構建生產環境
• make test：運行測試用例
• make docker-build：構建Docker鏡像
• make docker-run：運行Docker容器

📄 許可證

項目遵循[許可證名稱]協議，具體內容請參考[許可文件路徑]。

💡 貢獻指南

歡迎社區貢獻！如果你有任何問題或建議，請通過以下方式聯繫：

• 提交Issue到GitHub倉庫
• 發送郵件至聯繫郵箱
• 叉倉庫並提交Pull Request

在進行任何修改前，請仔細閱讀我們的貢獻規範文檔。