Frontapp MCP

🚀 Frontapp MCP 服務器

Frontapp MCP 服務器是一個用於將大型語言模型（LLMs）與 Frontapp 客戶溝通平臺集成的 Model Context Protocol (MCP) 服務器。它允許您通過文本接口或 Webhooks 即時監控和控制聊天，同時提供全面的分析功能。

🚀 快速開始

Frontapp MCP 服務器可助力您將大型語言模型與 Frontapp 平臺集成，實現即時對話監控與控制。以下是快速開始的步驟：

1. 克隆倉庫：

git clone git@github.com:yourusername/frontapp-mcp.git
cd frontapp-mcp

2. 安裝依賴：

npm install

3. 配置環境變量並運行：

cp .env.example .env
# 填寫你的Frontapp API密鑰和其他配置
npm run dev

✨ 主要特性

• 即時對話監控：通過文本接口或 Webhooks 即時接收所有對話更新。
• 自動化規則：根據預設條件自動暫停、修改或標記對話。
• 數據收集：獲取詳細的對話元數據以進行後續分析。
• 可擴展性：支持大規模團隊和高流量工作區。

📦 安裝指南

快速安裝

1. 克隆倉庫：

git clone git@github.com:yourusername/frontapp-mcp.git
cd frontapp-mcp

2. 安裝依賴：

npm install

3. 配置環境變量並運行：

cp .env.example .env
# 填寫你的Frontapp API密鑰和其他配置
npm run dev

💻 使用示例

基礎用法

客戶端示例

const mcp = new MCPClient('http://localhost:3000');

mcp.onMessage((message, context) => {
  console.log(`新消息：${message.text}`);
});

mcp.start();

Webhook 處理程序示例

export async function processWebhook(event) {
  if (event.type === 'new_message') {
    // 在這裡添加自定義邏輯
    await mcp.call('logMessage', { message: event.message });
  }
}

高級用法

1. 初始化 MCP 服務器

• 創建一個新工作區並在 Frontapp 中啟用 MCP 集成。
• 配置環境變量，包括：
  • FRONTAPP_API_KEY：您的 Frontapp API 密鑰
  • PORT：服務器監聽的端口（默認 3000）
  • 其他自定義設置

2. 連接 LLM

• 使用任何兼容的 LLM 服務提供商，如：
  • OpenAI
  • Anthropic (Claude)
  • Google (PaLM)

3. 配置 Webhooks

在webhooks.json中定義您的自定義邏輯：

{
  "規則ID": {
    "trigger": "event.type === 'message'",
    "action": "callWebhook('https://your-webhook-url')"
  }
}

📚 詳細文檔

完整的 API 文檔和開發指南，請參閱官方文檔。

🔧 技術細節

兼容性

• 支持與 Frontapp 的所有版本兼容
• 適用於任何集成的 LLM，包括 GPT - 4, Claude, PaLM 等

開發

快速開發命令

# 啟動開發服務器（支持熱重載）
npm run dev

# 運行測試
npm test

# 格式化代碼
npm run lint
npm run format

安全考慮

• 始終使用 HTTPS 進行通信
• 定期更新依賴庫以防止安全漏洞
• 配置適當的速率限制和身份驗證機制
• 對敏感數據進行加密存儲和傳輸

📄 許可證

本項目採用 MIT 許可證，詳情請參閱LICENSE文件。

重要鏈接

• 官方文檔
• Frontapp 開發人員文檔
• Model Context Protocol 規範

貢獻

歡迎任何貢獻！有關如何為該項目做出貢獻的詳細信息，請參閱Development Guide。

項目狀態