使用说明

项目简介

Logseq MCP Server 是一个 MCP 服务器,旨在将 Logseq 知识库的功能暴露给 LLM 客户端。通过该服务器,LLM 可以读取 Logseq 中的页面和块,创建新的页面和块,并执行编辑操作,从而实现与个人知识库的智能交互。

主要功能点

  • 资源管理: 虽然没有直接的资源 "托管和管理" 概念,但它通过工具和 prompt 提供了对 Logseq 知识库 (即资源) 的访问和操作能力。
  • 工具注册和执行: 提供了如 'logseq_insert_block', 'logseq_create_page', 'logseq_get_page' 等工具,允许 LLM 调用 Logseq 的功能。
  • Prompt 模板定义和渲染: 定义了与工具对应的 prompt,支持 LLM 通过 prompt 方式调用工具,并获取结构化响应。
  • JSON-RPC 通信: 虽然代码没有显式声明 JSON-RPC,但 MCP 协议本身基于 JSON-RPC,且使用了 'mcp.server.Server' 和 'stdio_server',暗示了底层的 JSON-RPC 通信机制。

安装步骤

  1. 确保已安装 Python 和 pip。
  2. 可以使用 pip 安装:
    pip install mcp-server-logseq
  3. 或者从源代码安装:
    git clone https://github.com/dailydaniel/logseq-mcp.git
    cd logseq-mcp
    cp .env.example .env
    uv sync

服务器配置

MCP 客户端配置(JSON 格式):

{
  "serverName": "LogseqMCP",
  "command": "python",
  "args": ["-m", "mcp_server_logseq", "--api-key", "<Your_Logseq_API_Token>", "--url", "http://localhost:12315"]
}

参数注释:

  • 'serverName': 服务器名称,可以自定义。
  • 'command': 启动服务器的命令,这里使用 'python'。
  • 'args': 启动参数列表。
    • '-m mcp_server_logseq': 运行 'mcp_server_logseq' 模块作为主程序。
    • '--api-key': Logseq API 令牌,必须替换为你的 Logseq API 令牌。你需要在 Logseq 中生成 API 令牌并在启动服务器时提供。
    • '--url': Logseq HTTP API 的 URL,默认为 'http://localhost:12315'。如果你的 Logseq 实例运行在不同的地址或端口,请修改此参数。

基本使用方法

  1. 确保 Logseq 桌面应用已启动并开启了本地 HTTP 服务器。
  2. 配置 Logseq API 令牌 (LOGSEQ_API_TOKEN 环境变量或 '--api-key' 参数)。
  3. 运行 MCP 服务器:'python -m mcp_server_logseq'
  4. 在 MCP 客户端中配置上述服务器配置信息。
  5. 在 MCP 客户端中使用提供的工具和 prompt 与 Logseq 知识库进行交互。例如,使用 'logseq_create_page' prompt 创建新页面,或使用 'logseq_get_page_content' prompt 获取页面内容。

信息

分类

生产力应用