Help Scout数据连接服务

一个MCP服务器,使AI助手能够直接访问Help Scout的收件箱、对话、客户、组织和线程数据,实现搜索票据、提取客户和账户上下文等功能。

  • by TajimaDirect
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 TajimaDirect/helpscout-mcp-server

使用说明

一 MCP服务器 这使AI助手可以直接访问您的Help Scout收件箱、对话、客户、组织和线程。无需离开编辑器或聊天窗口,即可搜索门票、提取客户和账户上下文、发现模式并获得答案。

由一位Help Scout客户创建,他希望为他的支持团队提供超能力。如果你在Help Scout中处理客户对话,并希望人工智能帮助你更快地工作,这是为你准备的。

你能做什么

  • 搜索对话 按关键字、日期范围、状态、标签、电子邮件域或票号
  • 查找客户 按名称、高级查询语法或确切的电子邮件地址
  • 探索组织 通过直接客户和对话遍历
  • 拉取完整的线程历史记录 在起草答复之前,先了解背景
  • 获取对话摘要 包含原始客户信息和最新员工回复
  • 监控收件箱活动 通过单个查询跨多个收件箱
  • 保持合规 具有可选的PII编辑和范围收件箱访问

快速开始

克劳德·科沃克(推荐)

安装 helpscout领航员 插件。它自动启动MCP服务器,包括 导航技能 帮助Claude为您的查询选择合适的搜索工具。

  1. 打开Cowork并转到 定制 > 浏览插件 > 个人
  2. 点击 + > 从GitHub添加市场 并进入 drewburchfield/help-scout-mcp-server
  3. 安装 helpscout领航员 来自市场
  4. 添加您的Help Scout凭据(分步指南)

该插件在MCP服务器上捆绑了指导技能、会话挂钩和工具选择指南。其他安装方法为您提供工具;这也教会了人工智能如何很好地使用它们。

克劳德桌面

一键安装 使用 桌面扩展:

  1. 下载最新 .mcpb 文件来自发布
  2. 双击安装(或拖动到Claude Desktop)
  3. 在提示时输入您的Help Scout应用程序ID和应用程序密码

克劳德代码

相同 helpscout领航员 该插件在Claude Code中工作,具有相同的导航技能。

  1. 跑 /plugin 在克劳德代码中打开市场
  2. 搜索 helpscout领航员 并安装它
  3. 集 HELPSCOUT_APP_ID 和 HELPSCOUT_APP_SECRET 作为环境变量
  4. 重新启动Claude代码

适用于游标、VS代码和其他MCP客户端

添加到MCP客户端的配置文件中(例如。, claude_desktop_config.json, .cursor/mcp.json):

{
  "mcpServers": {
    "helpscout": {
      "command": "npx",
      "args": ["help-scout-mcp-server"],
      "env": {
        "HELPSCOUT_APP_ID": "your-app-id",
        "HELPSCOUT_APP_SECRET": "your-app-secret"
      }
    }
  }
}

码头工人

docker run -e HELPSCOUT_APP_ID="your-app-id" \
  -e HELPSCOUT_APP_SECRET="your-app-secret" \
  drewburchfield/help-scout-mcp-server

获取API凭据

  1. 首选 帮助童子军 > 我的应用 > 创建私人应用程序
  2. 至少选择: 阅读 访问邮箱、对话、客户和组织
  3. 复制您的 应用ID 和 应用程序密钥

Help Scout仅使用OAuth2客户端凭据流。不支持个人访问令牌。

帮助侦察UI 环境变量
应用ID HELPSCOUT_APP_ID
应用程序密钥 HELPSCOUT_APP_SECRET

替代名称 HELPSCOUT_CLIENT_ID / HELPSCOUT_CLIENT_SECRET 和遗产 HELPSCOUT_API_KEY 也得到了支持。

工具

我应该使用哪个工具?

任务 工具 示例
列出最近的门票 searchConversations “显示本周的有效门票”
按关键字查找 comprehensiveConversationSearch “查找有关计费错误的对话”
查找票号 structuredConversationFilter “给我看看票#42839”
复杂过滤器 advancedConversationSearch “所有@acme.com对话都标记为紧急”
浏览客户 listCustomers “显示名为Jane的客户”
通过电子邮件查找客户 searchCustomersByEmail “寻找客户jane@acme.com"
检查客户资料 getCustomer “打开客户12345”
拉动客户联系渠道 getCustomerContacts “显示客户12345的联系方式”
浏览组织 listOrganizations “显示最繁忙的组织”
检查一个组织 getOrganization “开放组织456”
列出组织中的客户 getOrganizationMembers “456组织的成员是谁?”
列出组织对话 getOrganizationConversations “显示组织456的支持历史记录”
快速对话概述 getConversationSummary “总结此对话”
完整消息历史记录 getThreads “显示完整的线程”
当前服务器时间 getServerTime 用于时间相关搜索

服务器连接时会自动发现收件箱。AI代理会自动在指令中获取收件箱ID,因此不需要查找步骤。

配置

变量 描述 默认值
HELPSCOUT_APP_ID 来自Help Scout My Apps的应用程序ID 必填
HELPSCOUT_APP_SECRET 帮助侦察我的应用程序的应用程序秘密 必填
HELPSCOUT_DEFAULT_INBOX_ID 范围搜索到特定收件箱 无(所有收件箱)
HELPSCOUT_BASE_URL 帮助侦察API终结点 https://api.helpscout.net/v2/
REDACT_MESSAGE_CONTENT 在响应中隐藏消息正文 false
CACHE_TTL_SECONDS API响应的缓存持续时间 300
LOG_LEVEL 记录冗长(error, warn, info, debug) info

兼容性

适用于任何 MCP兼容 客户:

类别 客户
AI助理 Claude Desktop、Goose和其他启用MCP的助手
代码编辑器 光标、VS代码、Windsurf、Continue.dev
命令行 Claude Code、Codex、Gemini CLI、OpenCode
自定义 任何实施MCP标准的应用程序

安全与隐私

与具有合规意识的团队一起构建:

  • 可选的PII编辑。 默认情况下包含邮件正文。集 REDACT_MESSAGE_CONTENT=true 为了更严格的合规要求而隐藏它们。
  • 客户和组织编辑。 启用邮件内容编辑时,客户联系人字段和组织联系人/位置字段也会被编辑。
  • 安全身份验证。 OAuth2客户端凭据,具有自动令牌刷新功能。
  • 费率限制处理。 对429个响应进行指数回退的自动重试。
  • 范围访问。 可选的默认收件箱配置限制了AI可以搜索的内容。

故障排除

身份验证失败? 直接使用Help Scout验证您的凭据是否有效:

curl -X POST https://api.helpscout.net/v2/oauth2/token \
  -d "grant_type=client_credentials&client_id=$HELPSCOUT_APP_ID&client_secret=$HELPSCOUT_APP_SECRET"

空搜索结果? 常见原因:

  • 使用错误的搜索工具(使用 searchConversations 为了上市, comprehensiveConversationSearch 用于关键字搜索)
  • 收件箱ID不匹配。检查服务器指令中的ID,而不是猜测值。
  • 搜索词太窄。尝试更广泛的术语或更长的时间范围。

需要更多细节吗? 启用调试日志记录:

LOG_LEVEL=debug npx help-scout-mcp-server

发展

git clone https://github.com/drewburchfield/help-scout-mcp-server.git
cd help-scout-mcp-server
npm install && npm run build
npm start
npm test           # Run tests
npm run type-check # TypeScript validation
npm run lint       # Linting
npm run dev        # Development server with auto-reload

欢迎捐款。在提交PR之前,请确保测试、类型检查和测试通过。

支持

许可证

MIT许可证-请参阅 许可证 了解详情。