Logseq MCP

🚀 Logseq MCP 工具

本項目提供了一套模型上下文協議（MCP）工具，可讓 AI 代理與你的本地 Logseq 實例進行交互。

🚀 快速開始

📦 安裝指南

1. 確保你已安裝 Python 3.11 或更高版本。
2. 克隆此倉庫。
3. 安裝依賴項：

pip install -e .

🔧 配置步驟

1. 確保你的 Logseq 已啟用 API：

   • 在 Logseq 中，轉到“設置”>“高級”>“開發者模式”，啟用開發者模式。
   • 然後，轉到“插件”，開啟 Logseq 開發者插件。
   • 同時在高級設置中設置一個 API 令牌。
   • 重啟 Logseq。

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

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

或者

3. 配置 Claude Code 以使用 MCP 服務器：

claude mcp add

• 選擇作用域。
• 選擇 Stdio。
• 輸入 LOGSEQ_API_URL=http://localhost:12315 LOGSEQ_TOKEN=your-token-here /opt/homebrew/bin/uvx logseq-mcp

💻 使用示例

與 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 屬性。只需以正確的日期格式創建頁面，Logseq 會自動將其配置為具有相應屬性的日誌頁面。

塊結構和格式

Logseq 中的塊有一些重要特性需要了解：

1. 自動項目符號：所有塊在 Logseq 用戶界面中都會自動呈現為項目符號。
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 工具在你的圖譜上執行這些操作。

由 Modl 託管，Modl 團隊的任何提交或更改都是為了確保兼容性