Frontapp MCP Server

Frontapp MCP Server

site icon
2025.03.21 0
TypeScript客户沟通平台自动化工作流LLM 集成交流协作
Frontapp-MCP 是一个基于 Model Context Protocol (MCP) 的服务,旨在将大型语言模型 (LLMs) 与 Frontapp 的客户沟通平台集成。它充当 LLMs 和 Frontapp API 之间的桥梁,使 LLMs 能够通过自然语言命令访问和操作 Frontapp 数据(如对话、联系人、标签等),并自动化 Frontapp 的工作流程。该服务支持实时更新和基于事件的自动化,通过 Webhooks 从 Frontapp 接收事件。
View on GitHub

Overview

基本能力

产品定位

Frontapp-MCP 是一个集成服务,专注于将大型语言模型与 Frontapp 客户沟通平台连接起来,实现数据访问和工作流自动化。

核心功能

  • 对话管理:检索、创建、更新和管理对话
  • 联系人管理:访问和更新联系人信息
  • 标签管理:为对话添加和移除标签
  • 收件箱管理:访问收件箱信息
  • 用户管理:检索用户详细信息
  • Webhook 集成:接收和处理来自 Frontapp 的实时事件
  • 安全认证:验证 Webhook 签名和处理 API 认证
  • 安全凭证存储:使用 AES-256 加密存储敏感信息
  • HTTPS 支持:通过 TLS/SSL 加密确保通信安全

适用场景

  • 自动化客户支持流程
  • 通过自然语言命令管理客户对话
  • 实时监控和响应客户互动
  • 集成 LLMs 到现有的客户关系管理系统中

工具列表

  • Frontapp API 客户端:封装与 Frontapp API 交互的逻辑
  • Webhook 处理器:处理来自 Frontapp 的 Webhooks 并更新 LLM 上下文
  • 请求处理器:处理来自 LLMs 的请求并与 Frontapp API 交互
  • 数据模型:定义 LLMs、MCP 服务器和 Frontapp 之间交换的数据结构

常见问题解答

  • 如何确保通信安全?:使用 HTTPS 和 TLS/SSL 加密,验证 Webhook 签名,存储加密的 API 凭证。
  • 如何部署?:可以通过 Docker 容器化部署,支持多阶段构建优化生产镜像。
  • 开发时遇到 TypeScript 错误怎么办?:运行 npm run typechecknpm run build 本地检查并修复类型错误。

使用教程

使用依赖

  • Node.js (v16 或更高版本)
  • npm 或 yarn
  • Frontapp API 凭证
  • 用于 Webhooks 的公开可访问 URL(生产环境使用)

安装教程

  1. 通过 Smithery 自动安装: bash npx -y @smithery/cli install @zqushair/frontapp-mcp --client claude
  2. 手动安装步骤:
  3. 克隆仓库: bash git clone https://github.com/zqushair/Frontapp-MCP.git cd Frontapp-MCP
  4. 安装依赖: bash npm install
  5. 配置 .env 文件: bash cp .env.example .env # 编辑 .env 文件,填入 Frontapp API 凭证
  6. 构建并启动项目: bash npm run build npm start

调试方式

  • 启动开发服务器(支持热重载): bash npm run dev
  • 运行测试: bash npm run test:api npm run test:conversations npm run test:tags npm run test:contacts npm run test:webhooks
  • 代码检查和格式化: bash npm run lint npm run format

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。