article
README
🚀 MCP 联络服务器
MCP 联络服务器是一个模型上下文协议(MCP)服务器,它为您提供对 Intercom 对话和聊天的访问权限。借助该服务器,大型语言模型(LLMs)能够通过多种过滤选项,对您的 Intercom 会话进行查询和分析,为您的业务沟通数据挖掘提供有力支持。
🚀 快速开始
MCP 联络服务器允许大型语言模型(LLMs)通过各种过滤选项查询和分析您的 Intercom 会话。以下是使用该服务器的基本步骤:
- 克隆仓库:
git clone https://github.com/fabian1710/mcp-intercom.git
cd mcp-intercom
- 安装依赖项:
npm install
- 设置环境:
cp .env.example .env
- 将您的 Intercom API 密钥添加到
.env文件中:
INTERCOM_API_KEY=your_api_key_here
- 构建服务器:
npm run build
- 启动服务器:
npm start
✨ 主要特性
- 灵活查询:支持使用过滤选项查询 Intercom 对话,过滤选项包括日期范围(开始和结束日期)、客户 ID、会话状态等。
- 安全访问:使用 Intercom API 密钥进行安全访问,保障数据安全。
- 丰富数据:提供丰富的对话数据,涵盖基本对话信息、联系人信息、统计信息(响应数、重新打开次数)、状态和优先级信息等。
📦 安装指南
克隆仓库
git clone https://github.com/fabian1710/mcp-intercom.git
cd mcp-intercom
安装依赖
npm install
环境设置
cp .env.example .env
将您的 Intercom API 密钥添加到 .env 文件中:
INTERCOM_API_KEY=your_api_key_here
构建服务器
npm run build
💻 使用示例
运行服务器
启动服务器:
npm start
与 Claude for Desktop 配合使用
- 将服务器添加到您的 Claude for Desktop 配置文件(
~/Library/Application Support/Claude/claude_desktop_config.jsonmacOS 或%AppData%\Claude\claude_desktop_config.jsonWindows):
{
"mcpServers": {
"intercom": {
"command": "node",
"args": ["/path/to/mcp-intercom/dist/index.js"],
"env": {
"INTERCOM_API_KEY": "your_api_key_here"
}
}
}
}
- 重启 Claude for Desktop
可用工具 - search-conversations
使用过滤选项搜索 Intercom 对话。 参数:
createdAt(可选):包含operator(例如,">"、"<"、"=")和value( UNIX 时间戳)的对象,用于按创建日期筛选。updatedAt(可选):包含operator(例如,">"、 "<"、"=")和value(UNIX 时间戳)的对象,用于按更新日期筛选。sourceType(可选):对话的来源类型(例如,"email"、"chat")。state(可选):要筛选的会话状态(例如,"open"、"closed")。open(可选):布尔值,用于按打开状态筛选。read(可选):布尔值,用于按已读状态筛选。
示例查询:
- "搜索 2024 年 1 月 1 日之后创建的所有对话"
- "查找去年更新的对话"
- "列出所有开放的电子邮件对话"
- "获取所有未读对话"
🔧 技术细节
安全性
- 服务器需要 Intercom API 密钥才能运行,确保只有授权用户可以访问。
- 应妥善存储 API 密钥以确保安全,避免信息泄露。
- 服务器仅提供对对话的只读访问权限,保障数据的完整性。
- 所有 API 请求均通过适当的身份验证进行,防止非法访问。
开发
- 启动开发模式(自动重新编译):
npm run dev
- 运行代码检查:
npm run lint
🤝 贡献
如果您想为 MCP 联络服务器做出贡献,可以按照以下步骤进行:
- 叉克此仓库
- 为您的功能创建新分支
- 进行修改
- 提交拉取请求
📄 许可证
本项目采用 MIT 许可证。
扫码联系在线客服