使用说明

项目简介

TriliumNext MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，专为 TriliumNext 笔记应用设计。它允许大型语言模型 (LLM) 客户端（如 Claude Desktop）通过标准化的 MCP 协议，安全、可扩展地访问和管理您的 TriliumNext 笔记。该服务器提供了一系列工具，使 LLM 能够与您的个人知识库进行交互，实现更智能的应用场景。

请注意： 这是一个原型项目，建议仅供开发者使用，并务必在使用前备份您的 Trilium 笔记数据。

主要功能点

笔记管理工具: 提供了一系列用于操作 TriliumNext 笔记的工具，包括：
- 'search_notes': 在笔记中执行搜索。
- 'get_note': 根据 ID 获取笔记内容。
- 'create_note': 创建新的笔记。
- 'update_note': 更新现有笔记的内容。
- 'delete_note': 删除笔记。
MCP 协议支持: 实现了 MCP 协议，可以与任何兼容 MCP 协议的 LLM 客户端进行通信。
标准输入/输出 (stdio) 传输: 使用 stdio 作为默认的传输协议，易于集成和部署。
工具描述和参数定义: 清晰地定义了每个工具的功能、输入参数和要求，方便 LLM 客户端调用。

安装步骤

前提条件: 确保您已安装 Node.js 和 npm。

克隆仓库: 在您的本地计算机上克隆 GitHub 仓库 'https://github.com/tan-yong-sheng/triliumnext-mcp.git'。

git clone https://github.com/tan-yong-sheng/triliumnext-mcp.git
cd triliumnext-mcp

安装依赖: 在仓库目录下运行 'npm install' 安装项目依赖。
```
npm install
```
构建项目: 运行 'npm run build' 构建项目，生成可执行的 JavaScript 代码。
```
npm run build
```
配置环境变量: 您需要设置以下环境变量：
- 'TRILIUM_API_URL': 您的 TriliumNext API 地址。默认为 'http://localhost:8080/etapi'。如果您使用不同的端口或主机，请修改此变量。
- 'TRILIUM_API_TOKEN': 您的 TriliumNext API 访问令牌。您可以在 TriliumNext 的设置 -> API 访问中生成。这是必需的配置。

服务器配置 (MCP客户端)

要将此 MCP 服务器与 MCP 客户端（例如 Claude Desktop）连接，您需要在客户端的配置文件中添加服务器配置。以下是针对 Claude Desktop 的配置示例，您需要根据您的 MCP 客户端进行相应配置。

请注意: 以下配置中的路径 '/path/to/triliumnext-mcp/build/index.js' 需要替换为您实际的 'triliumnext-mcp' 项目 'build' 目录下 'index.js' 文件的绝对路径。

{
  "serverName": "triliumnext-mcp",
  "command": "node",
  "args": [
    "/path/to/triliumnext-mcp/build/index.js"  // 请替换为实际路径
  ],
  "env": {
    "TRILIUM_API_URL": "http://localhost:8080/etapi", // 可选: Trilium API 地址，默认为 http://localhost:8080/etapi
    "TRILIUM_API_TOKEN": "<YOUR_TRILIUM_API_TOKEN>" // 必填: 您的 Trilium API 令牌，请替换为实际令牌
  }
}

配置参数说明:

'serverName': 服务器名称，可以自定义，用于在客户端中标识该服务器。
'command': 启动服务器的命令，这里使用 'node' 来运行 JavaScript 代码。
'args': 传递给 'command' 的参数，这里指定了服务器入口文件 'index.js' 的路径。
'env': 环境变量，用于配置服务器运行时需要的参数，例如 Trilium API 的地址和令牌。

基本使用方法

配置完成后，您的 MCP 客户端应该能够连接到 TriliumNext MCP 服务器。您可以使用客户端提供的界面或 API 调用服务器提供的工具。例如，在 Claude Desktop 中，您可以通过自然语言指令，利用 'search_notes' 工具搜索笔记，或使用 'create_note' 工具创建新的笔记。

具体工具的使用方法和参数，请参考仓库 'README.md' 文件中 "Available Tools" 部分的详细描述。

关键词