内容
# remio-mcp
[](https://www.npmjs.com/package/remio-mcp)
[](LICENSE)
Remio 的 MCP(模型上下文协议)服务器 - 将您的 Remio 知识库暴露给像 Claude、Cursor 和任何兼容 MCP 的客户端的 AI 代理。
[中文文档](README.zh.md)
## 为什么选择 MCP 而不是 CLI?
Remio 已经自带了一个 CLI(`remio search_notes`、`remio rag`等),适用于在终端中手动使用。那么,为什么还要将其封装成 MCP 服务器?
**CLI 是为人类设计的。MCP 是为 AI 代理设计的。**
| | Remio CLI | remio-mcp |
|---|---|---|
| 用途 | 终端中的手动命令 | AI 代理直接调用工具 |
| 集成 | Shell 脚本、任务运行器 | Claude、Cursor、Craft Agents、任何 MCP 客户端 |
| 结构化输出 | 需要 `--json` 参数 | 始终结构化、类型化 |
| 在 Craft Agents 中 | 需要自定义技能 + Bash | 原生来源,在 Explore 模式下可用 |
| 可发现性 | AI 必须猜测命令语法 | AI 看到类型化的工具模式 |
在像 **Craft Agents** 这样的工具中,区别尤为明显:基于 CLI 的技能要求代理每次都组合 Shell 命令并解析原始输出。MCP 源是一个已注册、始终可用的集成 - 代理确切地知道存在哪些工具、它们需要哪些参数,并且可以在 Explore(只读)模式下无需额外设置调用它们。
简而言之,如果您将 Remio 与 AI 代理一起使用,MCP 为您提供了一种更干净、更可靠的集成,无需额外操作。
## 先决条件
- 已安装并运行 [Remio 桌面应用程序](https://remio.ai)
- 已安装 Remio CLI(`remio` 在您的 PATH 中,通常为 `~/.local/bin/remio`)
- Node.js 18+
## 安装
通过 npm 安装:
```bash
npm install -g remio-mcp
```
或直接使用 npx(无需安装):
```bash
npx remio-mcp
```
## 设置
### Claude Desktop / Claude Code
添加到您的 `claude_desktop_config.json`:
```json
{
"mcpServers": {
"remio": {
"command": "npx",
"args": ["-y", "remio-mcp"],
"env": {
"REMIO_PATH": "/Users/YOUR_USERNAME/.local/bin/remio"
}
}
}
}
```
### Craft Agents
添加到您的 workspace 源配置(`~/.craft-agent/workspaces/my-workspace/sources/remio/config.json`):
```json
{
"name": "Remio",
"slug": "remio",
"type": "mcp",
"mcp": {
"transport": "stdio",
"command": "npx",
"args": ["-y", "remio-mcp"],
"env": {
"REMIO_PATH": "/Users/YOUR_USERNAME/.local/bin/remio"
},
"authType": "none"
}
}
```
## 可用工具
| 工具 | 描述 |
|------|-------------|
| `search_notes` | 按查询、类型、日期、人员或收藏搜索笔记 |
| `read_note` | 按 ID 读取笔记的完整内容 |
| `create_note` | 创建新笔记 |
| `update_note` | 更新现有笔记 |
| `delete_note` | 删除笔记 |
| `add_note_to_collection` | 将笔记添加到收藏夹 |
| `remove_note_from_collection` | 从收藏夹中删除笔记 |
| `create_people_note` | 创建联系人/人员笔记 |
| `rag` | 使用 RAG 查询您的笔记 |
## 环境变量
| 变量 | 默认值 | 描述 |
|----------|---------|-------------|
| `REMIO_PATH` | `remio` | remio CLI 二进制文件的路径 |
使用以下命令查找您的 remio CLI 路径:`which remio` 或 `ls ~/.local/bin/remio`
## 使用示例
连接后,您可以询问您的 AI 代理:
- *"搜索我的 Remio 笔记关于设计系统"*
- *"我的笔记中关于 TypeScript 最佳实践的内容是什么?"*(使用 RAG)
- *"创建一篇标题为 '与 Alex 开会' 的笔记,包含以下行动项..."*
- *"查找上周关于产品路线图的笔记"*
## 开发
```bash
git clone https://github.com/GeekMai90/remio-mcp
cd remio-mcp
npm install
npm run build
```
在本地测试:
```bash
REMIO_PATH=~/.local/bin/remio node dist/index.js
```
## 许可证
MIT