项目简介

这是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在将您的 Vitally 客户数据和功能暴露给兼容的 LLM 客户端（如 Claude Desktop）。通过连接此服务器，LLM 可以访问 Vitally 中的客户信息，并执行某些操作，从而增强其处理客户相关查询和任务的能力。

主要功能点

客户账户资源： 将 Vitally 中的客户账户作为资源列出和读取详细信息。
用户搜索： 根据电子邮件或外部 ID 搜索 Vitally 用户。
账户搜索： 根据名称或外部 ID 搜索 Vitally 账户。
健康得分查询： 获取特定账户的健康得分信息。
会话与任务： 查看账户相关的近期会话和任务列表。
创建笔记： 为账户添加新的文本笔记。
工具发现： 搜索服务器提供的可用工具。
离线演示模式： 在未提供 Vitally API 密钥时，使用模拟数据运行，方便测试。

安装步骤

确保您已安装 Node.js 和 npm。
克隆或下载此 GitHub 仓库的代码。
在项目根目录打开终端。
安装项目依赖：
```
npm install
```

在项目根目录创建一个名为 '.env' 的文件，用于配置 Vitally API 连接信息。文件内容示例如下：

# Vitally API 配置
VITALLY_API_SUBDOMAIN=您的Vitally子域名  # 例如：nylas
VITALLY_API_KEY=您的API密钥  # 从 Vitally 账户设置中获取
VITALLY_DATA_CENTER=US  # 或 EU，取决于您的数据中心

您可以从 Vitally 账户的设置 > 集成 > REST API 中获取 API 密钥。
如果 '.env' 文件不存在或 'VITALLY_API_KEY' 未设置/使用默认占位符，服务器将自动进入演示模式，使用模拟数据运行。

构建项目：
```
npm run build
```

服务器配置

为了让您的 MCP 客户端（例如 Claude Desktop）能够连接并使用此服务器，您需要在客户端的配置文件中添加此服务器的启动信息。

通常，您需要配置以下信息：

服务器名称 (name): 为此服务器指定一个唯一的名称，例如 '"vitally-api"'。
启动命令 (command): 启动服务器的可执行文件，例如 '"node"'。
命令参数 (args): 启动服务器时需要传递的参数。对于此项目，参数通常包括：
- '--experimental-modules'
- '--experimental-specifier-resolution=node'
- 服务器构建后主文件的绝对路径，例如 '/Users/您的用户/vitally-mcp/build/index.js'（请务必替换为您系统中实际的路径）。

请参考您使用的 MCP 客户端的文档，查找如何添加自定义 MCP 服务器配置，并填写上述信息。

基本使用方法

成功将服务器配置到您的 MCP 客户端并启动客户端后，LLM 应该能够发现并使用此服务器提供的功能。您可以通过向 LLM 提出自然语言问题来利用这些功能，例如：

"列出所有我们的客户"
"查找名称中包含 'Acme' 的账户"
"账户 ID 为 [账户ID] 的健康得分是多少？"
"搜索电子邮件为 [email protected] 的用户"
"获取账户 ID 为 [账户ID] 的最近会话"
"为账户 ID [账户ID] 添加一条笔记，内容是 'Discussed Q3 performance'"
"我可以使用哪些工具来管理账户？"

LLM 会根据您的提问，自动调用服务器提供的相应工具或读取资源，并将结果反馈给您。

关键词

信息