内容
# Omi MCP Server
[](https://smithery.ai/server/@fourcolors/omi-mcp)
该项目提供了一个模型上下文协议(Model Context Protocol,MCP)服务器,用于与 Omi API 进行交互。该服务器提供了读取对话和记忆的工具,以及创建新的对话和记忆的功能。
## 设置
1. 克隆仓库
2. 使用 `npm install` 安装依赖
3. 创建一个 `.env` 文件,并添加以下变量:
```
API_KEY=your_api_key
APP_ID=your_app_id
```
## 使用方法
### 通过 Smithery 安装
要通过 [Smithery](https://smithery.ai/server/@fourcolors/omi-mcp) 自动安装 Omi MCP Server for Claude Desktop,请运行以下命令:
```bash
npx -y @smithery/cli install @fourcolors/omi-mcp --client claude
```
### 构建服务器
```bash
npm run build
```
### 运行服务器
```bash
npm run start
```
### 开发模式
用于热重载的开发:
```bash
npm run dev
```
### 测试服务器
包含一个简单的测试客户端,用于与MCP服务器交互。构建项目后,运行:
```bash
npm run test
```
或者直接运行:
```bash
./test-mcp-client.js
```
这将启动MCP服务器,并提供一个交互式菜单来测试可用的工具。测试客户端对所有操作使用默认的测试用户ID(`test-user-123`)。
### 清理和重建
要清理构建目录并从头开始重建:
```bash
npm run rebuild
```
## 与 Claude 和 Cursor 的配置
### Claude 配置
要通过 Anthropic Console 或 API 使用这个 MCP 服务器与 Claude 进行交互:
1. 在本地启动 MCP 服务器:
```bash
npm run start
```
2. 在设置你的 Claude 对话时,配置 MCP 连接:
```json
{
"mcp_config": {
"transports": [
{
"type": "stdio",
"executable": {
"path": "/path/to/your/omi-mcp-local/dist/index.js",
"args": []
}
}
]
}
}
```
3. 给 Claude 的示例提示:
```
请使用 Omi API 获取用户 "user123" 的最新 5 条对话。
```
4. Claude 将使用 MCP 执行 `read_omi_conversations` 工具:
```json
{
"id": "req-1",
"type": "request",
"method": "tools.read_omi_conversations",
"params": {
"user_id": "user123",
"limit": 5
}
}
```
### 光标配置
要使用此 MCP 服务器与光标(Cursor):
1. 在终端中启动 MCP 服务器:
```bash
npm run start
```
2. 在光标中,前往 设置 > 扩展 > MCP 服务器
3. 使用以下设置添加一个新的 MCP 服务器:
- 名称:Omi API
- URL:stdio:/path/to/your/omi-mcp-local/dist/index.js
- 启用服务器
4. 现在您可以直接在光标中使用 Omi 工具。例如:
```
@Omi API 请为用户 "user123" 获取记忆并进行总结。
```
5. 光标将与您的 MCP 服务器通信以执行必要的 API 调用。
## 可用工具
MCP Server 提供以下工具:
### read_omi_conversations
从 Omi 获取特定用户的对话,并可选择性地应用过滤器。
参数:
- `user_id` (string): 要获取对话的用户 ID
- `limit` (number, optional): 返回的最大对话数量
- `offset` (number, optional): 分页时要跳过的对话数量
- `include_discarded` (boolean, optional): 是否包含被丢弃的对话
- `statuses` (string, optional): 用逗号分隔的状态列表,用于过滤对话
### read_omi_memories
从 Omi 获取特定用户的记忆。
参数:
- `user_id` (string): 要获取记忆的用户 ID
- `limit` (number, optional): 返回的最大记忆数量
- `offset` (number, optional): 分页时要跳过的记忆数量
### create_omi_conversation
为特定用户在 Omi 中创建一个新的对话。
参数:
- `text` (string): 对话的完整文本内容
- `user_id` (string): 要为其创建对话的用户 ID
- `text_source` (string): 文本内容的来源(选项:"audio_transcript", "message", "other_text")
- `started_at` (string, optional): 对话/事件开始的时间(ISO 8601 格式)
- `finished_at` (string, optional): 对话/事件结束的时间(ISO 8601 格式)
- `language` (string, optional): 语言代码(默认:"en")
- `geolocation` (object, optional): 对话的位置信息
- `latitude` (number): 纬度坐标
- `longitude` (number): 经度坐标
- `text_source_spec` (string, optional): 关于来源的额外说明
### create_omi_memories
为特定用户在 Omi 中创建新的记忆。
参数:
- `user_id` (string): 要为其创建记忆的用户 ID
- `text` (string, optional): 用于提取记忆的文本内容
- `memories` (array, optional): 要直接创建的显式记忆对象数组
- `content` (string): 记忆的内容
- `tags` (array of strings, optional): 记忆的标签
- `text_source` (string, optional): 文本内容的来源
- `text_source_spec` (string, optional): 关于来源的额外说明
## 测试
要测试MCP Server,您可以使用提供的测试客户端:
```bash
node test-mcp-client.js
```
这将启动一个交互式测试客户端,允许您:
1. 获取对话
2. 获取记忆
3. 创建对话
4. 退出
测试客户端对所有操作使用默认的测试用户ID(`test-user-123`)。
## 日志记录
MCP Server 包含内置的日志记录功能,可以同时写入控制台和日志文件。这对于调试和监控服务器活动非常有用。
### 日志文件位置
日志被写入到项目目录中的 `logs/mcp-server.log`。日志文件包含时间戳和关于以下内容的详细信息:
- 服务器启动和关闭
- 所有 API 请求和响应
- 错误消息和堆栈跟踪
- 对 Omi 的 API 调用
- 请求参数和响应数据
### 查看日志
您可以使用 `tail` 命令实时查看日志:
```bash
tail -f logs/mcp-server.log
```
这将显示服务器处理请求和与 Omi API 交互时的实时更新。
### 日志格式
每个日志条目遵循以下格式:
```
[2024-03-21T12:34:56.789Z] 日志消息内容
```
时间戳采用 ISO 8601 格式,便于关联事件和调试问题。
连接信息
猜你喜欢
X视频文案提取
X / Twitter 视频文案提取 MCP Server — 专注解析 X 平台公开视频链接(x.com / twitter.com status...
cc-switch
跨平台的Claude Code、Codex和Gemini CLI一体化助手。
awesome-mcp-servers
一组 MCP 服务器。
Git
一个用于Git自动化和交互的模型上下文协议服务器。
oh-my-opencode
背景代理 · 精心挑选的代理,如 oracle、librarians、frontend engineer · 预构建工具,如 LSP/AST ·...
TrendRadar
TrendRadar:30秒内为您提供真实新闻的热点助手。