Esa

🚀 esa MCP 服務器

這是一個用於與 Esa 進行交互的 MCP（Middleware Component Protocol）服務器。藉助它，你可以通過命令行或其他工具集成 Esa 的功能，比如創建、更新和刪除項目、評論以及管理團隊成員。

🚀 快速開始

你可以按照以下步驟快速啟動 esa MCP 服務器：

環境要求

• 操作系統：支持 POSIX.1-2008 標準的操作系統（如 Linux、macOS 等）
• 軟件版本：
  • Node.js: v8 或更高
  • npm: 5.6.0 或更高

安裝步驟

1. 克隆倉庫：

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

2. 安裝依賴：

npm install

3. 配置環境變量：
   • 創建或修改 .env 文件：

     ESA_TOKEN=your_token_here
     ESA_TEAM_ID=your_team_id_here
     

4. 啟動服務器：

npm start

✨ 主要特性

項目相關

1. esa_list_projects - 獲取團隊中的所有項目。 輸入參數：
   • page (number, 可選)：要獲取的頁碼。
   • per_page (number, 可選)：每頁顯示的結果數量（最大值 100）。
2. esa_get_project - 獲取特定項目的詳細信息。 輸入參數：
   • project_id (string, 必填)：要獲取的項目 ID。
   • include (string, 可選)：指定需要關聯的數據（例如："members"、"comments"）。
3. esa_create_project - 創建新項目。 輸入參數：
   • name (string, 必填)：項目的名稱。
   • description (string, 可選)：項目的描述。
   • public (boolean, 可選)：是否公開項目，默認為 false。
4. esa_update_project - 更新現有項目的信息。 輸入參數：
   • project_id (string, 必填)：要更新的項目 ID。
   • name (string, 可選)：新的項目名稱。
   • description (string, 可選)：新的項目描述。
   • public (boolean, 可選)：是否公開項目的標誌。
5. esa_delete_project - 刪除特定項目。 輸入參數：
   • project_id (string, 必填)：要刪除的項目 ID。

評論相關

1. esa_list_comments - 獲取項目中的所有評論。 輸入參數：
   • project_id (number, 必填)：要獲取評論的項目 ID。
   • page (number, 可選)：頁碼。
   • per_page (number, 可選)：每頁顯示的結果數量（最大值 100）。
2. esa_get_comment - 獲取特定評論的詳細信息。 輸入參數：
   • comment_id (string, 必填)：要獲取的評論 ID。
   • include (string, 可選)：指定需要關聯的數據（例如："project"、"author"）。
3. esa_create_comment - 創建新的項目評論。 輸入參數：
   • project_id (number, 必填)：要評論的項目 ID。
   • body (string, 必填)：評論的內容（支持 Markdown 格式）。
   • author (string, 可選)：評論作者的屏幕名稱。

團隊成員相關

1. esa_get_members - 獲取團隊中的所有成員。 輸入參數：
   • page (number, 可選)：頁碼。
   • per_page (number, 可選)：每頁顯示的結果數量（最大值 100）。
2. esa_get_member - 獲取特定團隊成員的詳細信息。 輸入參數：
   • screen_name_or_email (string, 必填)：要獲取的成員的屏幕名稱或電子郵件地址。

💻 使用示例

基礎用法

創建新項目

# 創建名為 "My New Project" 的公開項目
curl --location 'http://localhost:3000/api/projects' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "My New Project",
    "description": "A new project for our team.",
    "public": true
}'

更新項目信息

# 更新項目 ID 123 的名稱和描述
curl --location 'http://localhost:3000/api/projects/123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Updated Project Name",
    "description": "This is an updated description."
}'

獲取項目評論

# 獲取項目 ID 456 的所有評論
curl --location 'http://localhost:3000/api/projects/456/comments' \
--header 'Content-Type: application/json'

📚 詳細文檔

錯誤處理

狀態碼說明

• 200 OK - 請求成功。
• 401 Unauthorized - 未授權或令牌無效。
• 404 Not Found - 資源不存在。
• 500 Internal Server Error - 服務器內部錯誤。

常見錯誤場景

1. 認證失敗

# 返回狀態碼 401 和以下內容：
{
  "error": "Unauthorized",
  "message": "Invalid token provided."
}

2. 資源未找到

# 返回狀態碼 404 和以下內容：
{
  "error": "Not Found",
  "message": "Project with ID 123 not found."
}

幫助和支持

• 文檔：esa-mcp 文檔
• 支持：聯繫 support@yourdomain.com