内容
# Dex MCP Server
一个模型上下文协议(Model Context Protocol,MCP)服务器,通过 Dex API 为 AI 代理提供全面的联系人关系管理功能。
## 特性
### 🚀 联系人管理
- **创建、读取、更新、删除** 联系人及其详细信息
- **按姓名、电子邮件或公司** 搜索联系人
- **全面的联系人字段**:姓名、公司、职位、描述、电子邮件、电话号码
### 📝 笔记管理
- **与联系人关联的笔记** 作为时间线项目存储
- **为任何联系人创建、更新、删除** 笔记
- **按内容搜索笔记**,覆盖所有联系人
- **大笔记集合的分页支持**
### ⏰ 提醒管理
- **设置与特定联系人关联的提醒**
- **根据需要完成、更新、删除** 提醒
- **按文本内容搜索提醒**
- **支持重复** 的跟进提醒
- **到期日期跟踪**,并进行适当的日期格式化
## 安装
### 先决条件
- Node.js 18 或更高版本
- Dex API 账户和 API 密钥
### 设置
1. 克隆此仓库:
```bash
git clone https://github.com/alpabon73/dex-mcp-server.git
cd dex-mcp-server
```
2. 安装依赖:
```bash
npm install
```
3. 在 `src/index.ts` 中配置您的 Dex API 密钥:
```typescript
const API_KEY = 'your-dex-api-key-here';
```
4. 构建服务器:
```bash
npm run build
```
## 使用
### 独立使用
```bash
npm start
```
### 与 AnythingLLM 一起使用
添加到您的 MCP 服务器配置:
```json
{
"mcpServers": {
"dex-mcp": {
"command": "/usr/local/bin/node",
"args": ["/path/to/dex-mcp-server/dist/index.js"],
"env": {}
}
}
}
```
## 可用工具
### 联系人工具 (6)
- `get_contacts` - 以分页方式检索联系人
- `get_contact_by_id` - 获取特定联系人的详细信息
- `search_contacts` - 按姓名/公司/电子邮件搜索
- `create_contact` - 添加新联系人
- `update_contact` - 修改现有联系人
- `delete_contact` - 删除联系人
### 笔记工具 (6)
- `get_notes_by_contact` - 获取某个联系人的所有笔记
- `get_all_notes` - 以分页方式检索所有笔记
- `search_notes` - 按内容搜索笔记
- `create_note` - 为联系人添加笔记
- `update_note` - 修改现有笔记
- `delete_note` - 删除笔记
### 提醒工具 (6)
- `get_reminders_by_contact` - 获取联系人的提醒
- `get_all_reminders` - 以分页方式检索所有提醒
- `search_reminders` - 按文本搜索提醒
- `create_reminder` - 设置新提醒
- `update_reminder` - 修改现有提醒
- `complete_reminder` - 将提醒标记为完成
- `delete_reminder` - 删除提醒
## 示例用例
- **“将 TechCorp 的 John Smith 添加为新联系人”**
- **“设置提醒,下周跟进 Sarah”**
- **“搜索关于 ABC 项目的所有笔记”**
- **“将 Mike 的职位更新为高级工程师”**
- **“显示本月所有待处理的提醒”**
- **“创建关于今天与客户会议的笔记”**
## 开发
### 脚本
- `npm run build` - 编译 TypeScript
- `npm run dev` - 使用 ts-node 进行开发运行
- `npm run watch` - 观察模式编译
- `npm start` - 运行已编译的服务器
### 架构
- **TypeScript** 用于类型安全
- **Zod** 用于模式验证
- **Axios** 用于向 Dex API 发起 HTTP 请求
- **MCP SDK** 用于协议实现
## API 集成
该服务器通过以下方式与 Dex API 集成:
- **GraphQL 端点**:`https://api.getdex.com/v1/graphql`
- **时间线项目** 用于笔记存储
- **提醒表** 与联系人连接
- **适当的分页** 和搜索功能
## 贡献
1. Fork 此仓库
2. 创建功能分支
3. 进行更改
4. 如适用,添加测试
5. 提交拉取请求
## 许可证
MIT 许可证 - 详见 LICENSE 文件
## 支持
有关以下问题的支持:
- **Dex API**:查看 [Dex 文档](https://docs.getdex.com)
- **MCP 协议**:参见 [MCP 规范](https://spec.modelcontextprotocol.io)
- **此服务器**:在此仓库中打开问题