Logseq MCP 工具

本项目提供了一组模型上下文协议 (MCP) 工具，使 AI 代理能够与您的本地 Logseq 实例进行交互。

安装

1. 确保您已安装 Python 3.11+
2. 克隆此仓库
3. 安装依赖项：

   pip install -e .
   

设置

1. 确保您的 Logseq 已启用 API。

   • 在 Logseq 中，转到“设置”>“高级”>“开发者模式”>“启用开发者模式”
   • 然后，转到“插件”>“启用 Logseq 开发者插件”
   • 还在“高级”设置中设置 API 令牌
   • 重启 Logseq

2. 在您的 Cursor MCP 配置文件中配置 MCP 服务器（通常位于 ~/.cursor/mcp.json）：

   {
     "mcpServers": {
       "logseq": {
         "command": "/opt/homebrew/bin/uvx",
         "args": ["logseq-mcp"],
         "env": {
           "LOGSEQ_API_URL": "http://localhost:12315",
           "LOGSEQ_TOKEN": "your-token-here"
         }
       }
     }
   }
   

与 Cursor 和 Claude 一起使用

添加到 Cursor 的 MCP 工具

1. 如上面的“设置”部分所示，配置 MCP 服务器

2. 打开 Cursor 并转到 MCP 面板（侧边栏）

3. Logseq 工具应出现在您的可用工具列表中

与 Claude 一起使用

在 Cursor 中使用 Claude 时，您需要告知它您可以使用 Logseq 工具，提示类似于：

“您可以使用 Logseq 工具来帮助您与我的 Logseq 图谱进行交互。您可以使用诸如 logseq.get_all_pages()、logseq.get_page(name)、logseq.create_page(name) 等函数。”

可用工具

所有工具都可以在 logseq 命名空间下使用：

页面

• logseq.get_all_pages: 获取 Logseq 图谱中所有页面的列表
• logseq.get_page: 按名称获取特定页面
• logseq.create_page: 创建一个新页面
• logseq.delete_page: 删除一个页面及其所有块

块

• logseq.get_page_blocks: 获取特定页面中的所有块
• logseq.get_block: 按 ID 获取特定块
• logseq.create_block: 在页面上创建一个新块
• logseq.insert_block: 将一个块作为另一个块的子块插入
• logseq.update_block: 更新现有块
• logseq.move_block: 将一个块移动到不同的位置
• logseq.remove_block: 删除一个块及其所有子块
• logseq.search_blocks: 搜索与查询匹配的块

使用 Logseq

日志页面

Logseq 中的日志页面具有特定的格式和属性：

1. 创建或访问日志页面时，使用 "mmm dth, yyyy" 格式（例如，"Apr 4th, 2025"）
2. 日志页面由 Logseq 自动格式化为正确的日期
3. 日志页面具有由 Logseq 自动设置的特殊属性：
   • journal?: true - 表示这是一个日志页面
   • journalDay: YYYYMMDD - 数字格式的日期（例如，20250404 代表 2025 年 4 月 4 日）
4. 示例：await logseq.create_page("Apr 4th, 2025")

重要提示： 您无需手动设置 journal? 或 journalDay 属性。只需使用正确的日期格式（例如，“Apr 4th, 2025”）创建一个页面，即可自动将其配置为具有相应属性的日志页面。

块结构和格式

Logseq 中的块有一些重要的特性需要理解：

1. 自动项目符号：所有块都会在 Logseq UI 中自动呈现为项目符号点

2. 页面链接：使用双括号创建链接：[[页面名称]]

3. 分层块：

   • 块结构数据包含分层信息：
     • parent: 父块的 ID
     • level: 缩进级别（顶层为 1，缩进块为 2+）
     • left: 左侧的块（通常是缩进块的父块）

4. 块内容：创建块时，您可以包含文本格式：

   • 支持基本的 Markdown（粗体、斜体等）
   • 块内的项目符号点可能支持有限
   • 支持多行内容，但可能受 Logseq 解析规则的约束

5. 日志块：在日志页面中创建的块继承特殊属性：

   • journal?: true
   • journalDay: YYYYMMDD - 与日志页面相同

注意： 与日志页面一样，这些块属性由 Logseq 自动处理。在日志页面上创建块时，您无需手动设置 journal? 或 journalDay 属性。

常见任务的示例用法

与 Cursor 代理一起使用： 当您在 Cursor 中配置了 Logseq MCP 工具时，您可以向代理发出如下提示：

• “创建一个名为‘会议记录’的新页面，其中包含今天议程的项目符号点”
• “将今天的任务添加到我的日志页面，并添加一个‘任务’部分”
• “使用 [[项目计划]] 更新今天的日志条目，将其子元素设置为‘已完成里程碑 1’”
• “在我的图谱中搜索关于‘python 项目’的块，并将它们组织到一个新页面上”

代理将使用适当的 Logseq 工具在您的图谱上执行这些操作。