TriliumNext Notes 的 MCP 服务器

⚠️ 免责声明：这是一个原型，用于解决 https://github.com/TriliumNext/Notes/issues/705 中的问题。仅建议开发者使用。在使用此工具之前，请备份您的 Trilium 笔记。 ⚠️

这是一个为 TriliumNext Notes 提供的模型上下文协议服务器。该服务器提供了通过 MCP 与您的 Trilium 笔记实例进行交互的工具。

快速开始

首先确保设置好环境变量：

• TRILIUM_API_URL（默认值：http://localhost:8080/etapi）
• TRILIUM_API_TOKEN（必需，从您的 Trilium 笔记设置中获取）
• PERMISSIONS（可选，默认值为 'READ;WRITE'，其中 READ 授予对 search_notes、get_note、resolve_note_id 和 read_attributes 的访问权限，而 WRITE 授予对 create_note、update_note、delete_note 和 manage_attributes 的访问权限）
• VERBOSE（可选，默认值为 'false'，如果设为 'true' 将打印详细的调试日志）

安装

1. 使用 Claude Desktop

将服务器配置添加到您的 Claude Desktop 配置文件中：

对于本地安装（Windows）

"triliumnext-mcp": {
  "command": "cmd",
  "args": [
        "/k",
        "npx",
        "-y",
        "triliumnext-mcp"
      ],
   "env": {
    "TRILIUM_API_URL": "http://localhost:8080/etapi",
    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
    "PERMISSIONS": "READ;WRITE"
  }
}

对于本地安装（Linux）

"triliumnext-mcp": {
  "command": "npx",
  "args": [
        "-y",
        "triliumnext-mcp"
      ],
   "env": {
    "TRILIUM_API_URL": "http://localhost:8_80/etapi",
    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
    "PERMISSIONS": "READ;WRITE"
  }
}

对于开发（Windows/Linux）

cd /path/to/triliumnext-mcp
npm run build

"triliumnext-mcp": {
  "command": "node",
  "args": [
        "/path/to/triliumnext-mcp/build/index.js"
  ],
  "env": {
    "TRILIUM_API_URL": "http://localhost:8080/etapi",
    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>",
    "PERMISSIONS": "READ;WRITE",
    "VERBOSE": "true"
  }
}

配置文件的位置：

• Windows: %APPDATA%/Claude/claude_desktop_config.json
• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json

反馈：请在 GitHub Issues 报告问题和测试结果

可用工具

该服务器提供了以下笔记管理工具：

搜索与发现工具

• search_notes - 统一搜索，具有全面的过滤能力，包括关键词搜索、日期范围、字段特定搜索、属性搜索、笔记属性、基于模板的搜索、笔记类型过滤、MIME 类型过滤以及层次导航。
• resolve_note_id - 根据标题查找笔记的ID。对于获取笔记ID以与其他工具一起使用至关重要。

笔记管理工具

• get_note - 通过ID检索笔记及其内容。也可以与正则表达式结合使用，从内容中提取特定模式。
• create_note - 创建新的笔记。支持9种笔记类型，并允许在同一步骤中创建属性（标签和关系）。
• update_note - 更新笔记的标题或内容。需要一个 mode（'overwrite' 或 'append'）来指定更新类型，并且需要一个 expectedHash 来防止冲突。
• delete_note - 永久删除笔记（⚠️ 无法撤销）。

属性管理工具

• read_attributes - 读取给定笔记的所有属性（标签和关系）。
• manage_attributes - 在笔记上创建、更新或删除属性。支持批量创建。

📖 详细使用：参见 笔记管理指南，了解修订控制策略和最佳实践。

示例查询

搜索与发现

• "找到我自2024年初以来关于'n8n'的最近10篇笔记"
• "显示我过去7天内编辑过的笔记"
• "列出'n8n Template'文件夹下的所有笔记，包括子文件夹"

内容管理

• "在我的工作日志中添加今天的更新"（使用 update_note 并设置 mode: 'append'）
• "用最终版本替换这个草稿"（使用 update_note 并设置 mode: 'overwrite'）
• "在我的日记文件夹中创建名为'每周回顾'的新笔记"

📖 更多示例：参见 用户查询示例，了解全面的使用场景。

文档

• 笔记管理指南 - 带有修订控制的安全内容编辑
• 用户查询示例 - 自然语言查询示例
• 搜索查询示例 - 高级搜索语法和过滤器

开发

如果您想贡献或修改服务器：

# 克隆仓库
git clone https://github.com/tan-yong-sheng/triliumnext-mcp.git

# 安装依赖
npm install

# 构建服务器
npm run build

# 开发时自动重建
npm run watch

贡献

欢迎贡献！如果您希望改进服务器，请熟悉官方 Trilium 搜索 DSL 文档 和我们的内部 搜索查询示例，以理解如何构建搜索查询。

请随时打开一个问题或提交一个拉取请求。