Freshdesk MCP

🚀 Freshdesk MCP 服務器

一個與 Freshdesk 集成的 MCP 服務器實現，可讓 AI 模型與 Freshdesk 模塊交互，執行各類支持操作，極大提升支持工作的效率和智能化程度。

🚀 快速開始

安裝方法

使用 Smithery 進行安裝

# 使用以下命令在終端中運行安裝腳本
smithery install @effytech/freshdesk-mcp

手動安裝

1. 下載並提取壓縮包：

   wget https://example.com/freshdesk-mcp.zip && unzip freshdesk-mcp.zip
   

2. 安裝依賴項：

   npm install
   

3. 啟動服務器：

   node index.js
   

先決條件

• Node.js 14 或更高版本
• npm 6 或更高版本
• Freshdesk 賬戶及 API 訪問權限

✨ 主要特性

• Freshdesk 集成：與 Freshdesk API 端點無縫交互
• AI 模型支持：允許 AI 模型通過 Freshdesk 執行支持操作
• 自動化工單管理：處理工單的創建、更新和響應

📦 安裝指南

安裝方法

使用 Smithery 進行安裝

# 使用以下命令在終端中運行安裝腳本
smithery install @effytech/freshdesk-mcp

手動安裝

1. 下載並提取壓縮包：

   wget https://example.com/freshdesk-mcp.zip && unzip freshdesk-mcp.zip
   

2. 安裝依賴項：

   npm install
   

3. 啟動服務器：

   node index.js
   

💻 使用示例

基礎用法

創建工單

curl -X POST http://localhost:3000/api/tickets \
     -H "Content-Type: application/json" \
     -d '{"subject":"問題報告","description":"遇到一個嚴重的問題。"}'

更新工單狀態

curl -X PUT http://localhost:3000/api/tickets/123/status \
     -H "Content-Type: application/json" \
     -d '{"status":2}'

📚 詳細文檔

組件

工具

該服務器提供了多個用於 Freshdesk 操作的工具：

• create_ticket：創建新支持工單

  • 輸入：
    • subject (字符串，必需)：工單主題
    • description (字符串，必需)：工單描述
    • source (數字，必需)：工單來源代碼
    • priority (數字，必需)：工單優先級級別
    • status (數字，必需)：工單狀態代碼
    • email (字符串，可選)：請求者的電子郵件
    • requester_id (數字，可選)：請求者 ID
    • custom_fields (對象，可選)：工單自定義字段

• update_ticket：更新現有工單

  • 輸入：
    • ticket_id (數字，必需)：要更新的工單 ID
    • updates (對象，必需)：要更新的字段

• delete_ticket：刪除一個工單

  • 輸入：
    • ticket_id (數字，必需)：要刪除的工單 ID

• search_tickets：根據條件搜索工單

  • 輸入：
    • query (字符串，必需)：搜索查詢字符串

• get_ticket_fields：獲取所有工單字段

  • 輸入：
    • 無

• get_tickets：獲取所有工單

  • 輸入：
    • page (數字，可選)：要獲取的頁碼
    • per_page (數字，可選)：每頁顯示的工單數量

• get_ticket：獲取一個單一工單

  • 輸入：
    • ticket_id (數字，必需)：要獲取的工單 ID

配置

示例配置文件（config.json）

{
  "freshdesk": {
    "url": "https://your-subdomain.freshdesk.com",
    "api_key": "your_api_key"
  },
  "mcp": {
    "port": 3000,
    "host": "localhost"
  }
}

設置環境變量

export FRESHDESK_URL="https://your-subdomain.freshdesk.com"
export FRESHDESK_API_KEY="your_api_key"

測試

單元測試

運行以下命令執行單元測試：

npm test

集成測試

運行以下命令執行集成測試：

npm run integration-test

故障排除

1. 端口衝突：確保沒有其他服務佔用 3000 端口。
2. 連接問題：檢查網絡連接和 API 服務狀態。
3. 配置錯誤：核實 config.json 文件是否正確。

常見問題解答

• 如何更改默認端口？

  • 修改 config.json 中的 port 參數。

• 無法連接到 Freshdesk？

  • 檢查 API URL 和密鑰是否正確。

🔧 技術細節

• 端口：默認為 3000
• 協議：HTTP/HTTPS
• 支持的格式：JSON

📄 許可證

此 MCP 服務器根據 MIT 許可證發佈。有關詳細信息，請參閱項目倉庫中的 LICENSE 文件。

⚠️ 重要提示

在生產環境中，請確保 API 密鑰的安全性。定期更新 API 密鑰以增強安全性。配置文件應置於安全的位置，避免未授權訪問。