使用说明

项目简介

LogSeq MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它充当 LLM（大型语言模型）客户端和 LogSeq 知识管理系统之间的桥梁。通过此服务器，LLM 能够以标准化的方式访问和操作 LogSeq 中的笔记数据，实现知识库的智能交互。

主要功能点

连接 LogSeq 知识库: 通过 LogSeq 的 API 接口，连接到您的本地 LogSeq 知识库。
提供工具 (Tools):
- 'list_graphs': 列出所有可用的 LogSeq 图谱（graphs）。 (仓库代码中未实现，但README中有提及)
- 'list_pages': 列出当前 LogSeq 图谱中的所有页面。
- 'get_page_content': 获取指定页面的内容。 (仓库代码中未实现，但README中有提及)
- 'search': 在所有页面中搜索内容。 (仓库代码中未实现，但README中有提及)
- 'create_page': 创建新的 LogSeq 页面。
- 'update_page': 更新现有页面的内容。 (仓库代码中未实现，但README中有提及)
- 'delete_page': 删除页面。 (仓库代码中未实现，但README中有提及)
Prompt 示例: 提供了一些 Prompt 示例，帮助用户理解如何指示 LLM 使用这些工具与 LogSeq 交互。例如，查询会议记录、搜索项目信息、创建或更新笔记等。

安装步骤

环境准备: 确保您已安装 Python 3.8+ 和 uv (Rust-based virtual environment and package manager)。如果尚未安装 uv，请参考 uv installation 进行安装。
同步依赖: 克隆仓库到本地后，在项目根目录下运行 'uv sync' 命令，安装项目依赖。

服务器配置

MCP 客户端需要配置以下 JSON 信息以启动 LogSeq MCP Server 并与之建立连接。请注意，您需要预先获取 LogSeq 的 API Token 并配置 LogSeq API 的 URL。

{
  "mcp-logseq": {
    "command": "uvx",  // 启动命令，这里使用 uvx 执行 Python 包
    "args": [
      "mcp-logseq"   // 命令参数，这里指定运行 mcp-logseq 包
    ],
    "env": {
      "LOGSEQ_API_TOKEN": "<your_api_token_here>",  // LogSeq API Token，请替换为您的 Token
      "LOGSEQ_API_URL": "http://localhost:12315"   // LogSeq API URL，默认为 http://localhost:12315，如果您的 LogSeq API 地址不同，请修改此处
    }
  }
}

配置说明:

'"mcp-logseq"': 服务器名称，可以自定义。
'"command": "uvx"': 指定用于启动服务器的命令为 'uvx'，它是 'uv' 包管理器提供的命令执行器，用于在虚拟环境中执行包。
'"args": ["mcp-logseq"]': 指定传递给 'uvx' 命令的参数，这里 '"mcp-logseq"' 指的是要运行的 Python 包名称，对应项目中的 'mcp_logseq' 包。
'"env"': 环境变量配置，用于传递 LogSeq API 的相关配置信息。
- '"LOGSEQ_API_TOKEN"': 必需。您的 LogSeq API 访问令牌，需要替换为实际的 Token 值。
- '"LOGSEQ_API_URL"': 可选。LogSeq API 的 URL 地址，默认为 'http://localhost:12315'。如果您的 LogSeq API 服务运行在不同的地址或端口，请修改此配置。

注意: 您也可以选择在工作目录下创建 '.env' 文件来配置 'LOGSEQ_API_TOKEN' 和 'LOGSEQ_API_URL' 环境变量，具体内容参考仓库 README.md。

基本使用方法

启动 MCP Inspector (或其他 MCP 客户端): 使用 MCP Inspector 或其他兼容的 MCP 客户端。
配置服务器: 在 MCP 客户端中，添加上述提供的服务器配置 JSON。
连接服务器: 启动 MCP 客户端，客户端会根据配置启动 LogSeq MCP Server 并建立连接。
调用工具: 在 MCP 客户端中，您可以指示 LLM 调用 LogSeq MCP Server 提供的工具，例如 'list_pages' 或 'create_page'，以实现与 LogSeq 知识库的交互。

调试

如果需要调试，可以使用 MCP Inspector，按照 README.md 中提供的调试命令进行操作。

关键词