Custify MCP Server

@客户化/mcp服务器

](https://www.npmjs.com/package/@custify/mcp-server)   ](https://github.com/CustifyOfficial/custify-mcp)

通过模型上下文协议将AI工具连接到您的Custify客户成功数据。

查询帐户、健康评分、使用数据等，或创建笔记、任务和触发剧本，所有这些都可以在Claude、Cursor、VS Code或任何兼容MCP的AI工具中完成。

______________________________________________________________________

快速开始

在2分钟内起床跑步。

1.获取API密钥

首选 Custify设置>开发人员>API访问 并创建或复制您的API密钥。

2.安装

npx @custify/mcp-server

3.配置您的AI工具

请参阅 配置 下面的部分针对您的特定工具。

4.试试看

问你的AI助手：

How many churned accounts do I have?

______________________________________________________________________

配置

Claude Desktop (STDIO)

将以下内容添加到您的 claude_desktop_config.json:

macOS： ~/Library/Application Support/Claude/claude_desktop_config.json 窗户： %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "custify": {
      "command": "npx",
      "args": ["-y", "@custify/mcp-server"],
      "env": {
        "CUSTIFY_API_KEY": "your-api-key-here"
      }
    }
  }
}

保存后重新启动Claude Desktop。

Cursor (STDIO)

1. 打开 设置>MCP
2. 点击 添加新的MCP服务器
3. 使用以下配置：

• 姓名： custify
• 命令： npx -y @custify/mcp-server
• 环境变量： CUSTIFY_API_KEY=your-api-key-here

VS Code (STDIO)

添加到您的 .vscode/mcp.json 在您的工作区根目录中：

{
  "servers": {
    "custify": {
      "command": "npx",
      "args": ["-y", "@custify/mcp-server"],
      "env": {
        "CUSTIFY_API_KEY": "your-api-key-here"
      }
    }
  }
}

Claude Code (CLI)

claude mcp add custify -- npx -y @custify/mcp-server \
  --env CUSTIFY_API_KEY=your-api-key-here

ChatGPT (Streamable HTTP)

ChatGPT需要基于HTTP的MCP服务器。使用Docker进行部署：

docker run -d \
  -p 3000:3000 \
  -e CUSTIFY_API_KEY=your-api-key-here \
  ghcr.io/custifyofficial/custify-mcp:latest

然后配置ChatGPT以连接到服务器的URL：

https://your-server.example.com/mcp

Other MCP Clients

Custify MCP服务器支持两种传输方式：

• 工作室 （默认）：运行 npx @custify/mcp-server 随着 CUSTIFY_API_KEY 环境变量集。
• 流式HTTP：设置 MCP_TRANSPORT=streamable-http 服务器将监听端口3000（可通过以下方式配置 PORT).MCP端点为 /mcp.

有关如何使用任一传输配置MCP服务器，请参阅MCP客户端的文档。

______________________________________________________________________

可用工具

帐户工具

list_accounts 支持 tag_ids 用于简单的标签过滤和Custify用于高级领域的完整过滤系统。使用 list_tags 随着 category: "company" 将帐户标签名称解析为ID。使用 list_attributes 随着 entity_type: "account" 以发现可用字段。

标签过滤器在手动传递时使用此后端格式 filters:

{
  "fieldName": "tags",
  "fieldType": "Tag",
  "filterType": "is_any_of",
  "filterValue": [""]
}

支持的标签 filterType 值是 is_any_of, is_all_of, is_none_of, is_unknown，以及 any_value对于基于ID的标签过滤器， filterValue 必须是非空的标记ID数组。

筛选器示例：

按字段类型列出的可用筛选器类型：

联系工具

list_contacts 接触等效于 list_accounts.使用 tag_ids 使用人员标签进行简单的标签过滤，或通过高级Custify过滤器。使用 list_tags 随着 category: "people" 将联系人标签名称解析为ID。使用 list_attributes 随着 entity_type: "contact" 以发现可用的联系人字段。

联系人筛选器示例：

健康和使用工具

警报和分段

任务工具

list_tasks 使用平坦的人体工程学参数。过滤器与AND结合使用。要将“入职跟进”等标签名称解析为ID，请致电 list_tags 随着 category: "task"。要解析受让人姓名，请致电 list_task_filter_values （返回带名称的用户ID）。

筛选器示例：

可用状态值：

用途 list_accounts 使用搅拌过滤器来计算搅拌=真的账户。

“显示健康评分低于30的所有帐户” 用途 list_attributes 要查找健康评分字段名称，请执行以下操作 list_accounts 使用数字过滤器。

“查找由管理的所有帐户jane@company.com" 用途 list_accounts CSM字段上有一个用户过滤器。

“本季度注册了哪些账户？” 用途 list_accounts 使用日期筛选器： filterType: "this_quarter" 上 signed_up_at.

“显示标记为续订风险的帐户” 用途 list_tags 随着 category: "company" 要解析标签ID，则 list_accounts 随着 tag_ids.

查询联系人

“显示标记为冠军的联系人” 用途 list_tags 随着 category: "people" 要解析标签ID，则 list_contacts 随着 tag_ids.

“查找具有example.com电子邮件地址的联系人” 用途 list_contacts 启用字符串筛选器 email.

账户深度挖掘

“给我一份Acme Corp的完整摘要” 用途 search_accounts 那就去找Acme吧 get_account, get_health_scores, get_contacts, get_usage_data，以及 get_segment_membership 建立一个全面的简报会。

“Acme公司在哪些领域？” 用途 search_accounts 要查找帐户ID，则 get_segment_membership.

“向我展示Acme Corp上个月的健康评分趋势” 用途 get_health_scores 要查找分数ID，则 get_usage_trends 历史价值。

查询任务

“今天我的盘子里有什么？” 用途 list_tasks 随着 assignee_id （您的用户ID）和 due: "today" 提取每日任务列表。

“显示分配给Jane的所有标记为“入职跟进”的逾期任务” 用途 list_tags 随着 category: "task" 为了将标签名称解析为ID， list_task_filter_values 要解析Jane的用户ID，则 list_tasks 随着 tag_ids, assignee_id，以及 status: "overdue".

“Acme Corp有什么机会？” 用途 search_accounts 要查找帐户ID，则 list_tasks 随着 account_id 和 status: "open".

查询目标

“Acme Corp有哪些目标？” 用途 search_accounts 要查找帐户ID，则 get_account_objectives.

采取行动

“为Acme Corp创建一个后续任务：审查入职进度，下周五到期” 用途 search_accounts 那就去找Acme吧 create_task 带有标题、截止日期和帐户ID。

“向Acme Corp添加注释：与工程副总裁就API延迟问题进行了交谈” 用途 search_accounts 然后 create_note 与笔记正文。

“运行Acme Corp的续约准备手册” 使用 playbooks 查找剧本ID的资源， search_accounts 对于账户，那么 run_playbook.

“将Acme Corp标记为续约风险” 用途 search_accounts 为了找到帐户ID， list_tags 或 custify://tags 要查找标签ID，则 add_tag_to_entities.

发现您的数据模型

“我可以按哪些字段筛选帐户？” 用途 list_attributes 返回所有可用字段及其名称和类型。

“我们有哪些细分市场？” 阅读 custify://segments 资源。

“有什么剧本？” 阅读 custify://playbooks 资源。

“我们有哪些计算指标和生命周期阶段？” 阅读 custify://calculated-metrics 和 custify://lifecycles 资源。

“我可以在帐户和联系人上使用哪些标签？” 阅读 custify://tags 资源。

______________________________________________________________________

环境变量

______________________________________________________________________

码头工人

将服务器作为基于HTTP的MCP客户端的Docker容器运行：

docker run -d \
  --name custify-mcp \
  -p 3000:3000 \
  -e CUSTIFY_API_KEY=your-api-key-here \
  ghcr.io/custifyofficial/custify-mcp:latest

MCP端点将在 http://localhost:3000/mcp 健康检查终点位于 http://localhost:3000/health.

______________________________________________________________________

安全

• 数据流： 您的人工智能工具与Custify MCP服务器进行通信，然后后者对Custify REST API进行经过身份验证的API调用。MCP服务器本身不存储任何数据。
• API密钥处理： 你的 CUSTIFY_API_KEY 从环境变量中读取，从不记录、缓存或通过MCP响应公开。使用STDIO传输时，密钥保留在本地进程中。使用HTTP传输时，请确保您的部署在TLS之后。
• 权限： MCP服务器继承您的API密钥的权限。使用范围为工作流所需最低访问级别的密钥。只读键适用于所有读取工具；写工具需要具有写权限的密钥。
• 无遥测： 服务器不会收集分析数据或将数据发送给任何第三方。

______________________________________________________________________

故障排除

“错误：CUSTIFY_API_KEY环境变量是必需的” 确保 CUSTIFY_API_KEY 环境变量在MCP客户端配置中设置。仔细检查拼写错误，确保没有多余的空格。

Claude Desktop中的服务器未连接

1. 验证配置文件路径是否适用于您的操作系统。
2. 请确保在编辑配置后重新启动了Claude Desktop。
3. 检查一下 npx 在您的系统PATH中可用。

身份验证错误（401） 您的API密钥可能无效或已过期。从生成新密钥 Custify设置>开发人员>API访问.

权限错误（403） 端点可能无法用于API密钥访问。检查您的Custify帐户是否具有所需的权限。

超时或连接错误 如果使用HTTP传输，请验证服务器是否正在运行且可访问。检查一下 PORT 环境变量与您的部署配置相匹配。对于STDIO传输，确保没有防火墙或代理阻止本地进程通信。

不同的Custify集群？ 如果您的Custify实例位于不同的集群（例如EU）上，请设置 CUSTIFY_API_URL 到集群的API URL。

Docker容器立即退出 检查容器日志 docker logs custify-mcp最常见的原因是失踪 CUSTIFY_API_KEY 环境变量。

______________________________________________________________________

贡献

欢迎投稿！开始：

git clone https://github.com/CustifyOfficial/custify-mcp.git
cd custify-mcp-server
npm install
npm run dev

1. 分叉存储库
2. 创建要素分支： git checkout -b feature/my-feature
3. 进行更改并添加测试
4. 运行测试套件： npm test
5. 提交拉取请求

如果您计划进行重大更改，请先打开一个问题。

______________________________________________________________________

许可证

麻省理工学院-见 许可证 了解详情。