客户支持协议服务器

Groove MCP服务器是一个模型上下文协议服务器,通过Groove GraphQL API v2提供客户支持工单、CRM和知识库功能。

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

使用说明

Groove MCP服务器

Groove HQ的模型上下文协议(MCP)服务器,通过Groove GraphQL API v2提供对客户支持票务、CRM和知识库功能的访问。

安装

从获取GROVE_API_TOKENhttps://YOUR_SUBDOMAIN.groovehq.com/settings/developer/api?tat-cursor=1&tat实体类型=access令牌&tat页面大小=9999

然后将Groove MCP服务器添加到Claude Code中:

claude mcp add groove-mcp npx groove-mcp -s user --env GROOVE_API_TOKEN=your_groove_api_token_here

您还可以选择设置 GROOVE_API_URL 作为环境变量(默认为 https://api.groovehq.com/v2/graphql).

如果你想在本地运行它,克隆这个仓库,然后运行:

claude mcp add groove-mcp node ~/path/to/groove-mcp/index.js -s user --env GROOVE_API_TOKEN=your_groove_api_token_here

可用工具

会话管理

  • list对话 -使用可选筛选器列出对话

    • status:按状态筛选(未读、已打开、已关闭、已打盹)
    • assigneeId:按分配的代理ID筛选
    • contactId:按联系人ID筛选
    • tagIds:按标签ID筛选
    • limit:要返回的最大对话数(默认值:20)
  • getConversation -获取特定对话的详细信息

    • id:对话ID(必填)
  • 创建对话 -创建新对话

    • contactId:联系人ID(必填)
    • subject:对话主题(必填)
    • body:初始消息正文(必填)
    • assigneeId:要分配给的代理ID
    • tagIds:要应用的标签ID
  • updateConversation -更新对话

    • id:对话ID(必填)
    • status:新状态(打开、关闭、打盹)
    • assigneeId:要分配给的代理ID
    • tagIds:要应用的标签ID
    • snoozedUntil:ISO 8601日期时间可暂停至
  • close对话 -结束对话

    • id:要关闭的对话ID(必填)

消息操作

  • list消息 -列出对话中的消息

    • conversationId:要列出消息的对话ID(必填)
    • limit:要返回的最大邮件数(默认值:50)
    • after:分页光标
  • 消息 -在对话中发送消息

    • conversationId:要向其发送消息的对话ID(必填)
    • body:消息正文内容(必填)
    • attachmentIds:要包含的附件的ID
  • createNote -在对话中创建内部笔记

    • conversationId:要添加注释的对话ID(必填)
    • body:备注内容(必填)

联系人管理

  • list联系人 -使用可选搜索列出联系人

    • search:搜索字符串以筛选联系人
    • limit:要返回的最大联系人数(默认值:20)
    • after:分页光标
  • 获取联系方式 -获取特定联系人的详细信息

    • id:联系人ID(必填)
  • 创建联系人 -创建新联系人

    • email:联系电子邮件地址(必填)
    • firstName:联系人名字
    • lastName:联系人姓氏
    • company:联系公司
    • title:联系职位
    • phone:联系电话
  • 更新 -更新联系信息

    • id:联系人ID(必填)
    • email:联系电子邮件地址
    • firstName:联系人名字
    • lastName:联系人姓氏
    • company:联系公司
    • title:联系职位
    • phone:联系电话

代理操作

  • listAgent -列出组织中的所有代理

  • getAgent -获取特定代理的详细信息

    • id:代理ID(必填)
  • 获取可用代理 -列出所有可用的代理

知识库

  • searchKbArticles -搜索知识库文章
    • query:搜索查询(必填)
    • limit:要返回的最大文章数(默认值:20)

资源

服务器将知识库文章作为MCP资源公开。MCP客户端可以浏览和读取这些内容。

  • 知识库文章 -已发布的知识库文章可作为资源提供
    • 每篇文章都包括元数据,如类别、视图和有用投票
    • 文章在阅读时以Markdown格式返回

发展

# Watch mode for development
npm run dev

# Run tests
npm test

# Lint code
npm run lint

# Type check
npm run typecheck

项目结构

├── src/
│   ├── index.ts           # Main server entry point
│   ├── groove-client.ts   # GraphQL client wrapper
│   ├── tools/             # MCP tool implementations
│   │   ├── conversations.ts
│   │   ├── messages.ts
│   │   ├── contacts.ts
│   │   └── agents.ts
│   ├── resources/         # MCP resource implementations
│   │   └── kb-articles.ts
│   ├── types/             # TypeScript type definitions
│   │   └── groove.ts
│   └── utils/             # Utility functions
│       └── graphql-queries.ts
├── tests/                 # Test files
├── docs/                  # Documentation
└── dist/                  # Compiled JavaScript files

许可证

麻省理工学院