Siyuan Note Taking

🚀 一個為Siyuan筆記提供MCP服務的小插件

該插件專為Siyuan Note提供MCP服務，能有效拓展筆記的功能，提升使用體驗。

🚀 快速開始

• 下載插件：你可以從市場直接下載插件，也可以按以下步驟操作：
  1. 下載Release中的package.zip文件；
  2. 將解壓後的文件夾移動到workspace/data/plugins/目錄下；
  3. 把該文件夾重命名為syplugin-anMCPServer。
• 啟用插件：完成下載和重命名後，啟用該插件。
• 訪問服務器：插件默認監聽端口為16806（主機地址為127.0.0.1），請使用http://127.0.0.1:16806/sse作為服務器訪問地址。

⭐ 如果該插件對你有幫助，請考慮給它點個星！

✨ 主要特性

支持的工具

• 搜索：
  • 可使用關鍵詞進行搜索。
  • 支持使用SQL語句進行搜索。
• 檢索：
  • 能根據ID獲取文檔內容（kramdown格式）。
  • 可以列出所有筆記本。
• 寫入：
  • 可向日記中追加內容。
  • 能根據指定ID向特定文檔追加內容。

❓ 常見問題解答

Q: 如何在MCP客戶端中使用它？

A: 修改MCP應用程序的配置，選擇SSE類型，並配置訪問端點，例如：

{
    "mcpServers": {
        "siyuan": {
            "type": "sse",
            "command": "http://127.0.0.1:16806/sse",
            "args": [
                ""
            ],
            "env": {},
            "auto_approve": false
        }
    }
}

Q: 我的MCP客戶端不支持HTTP通信，只支持stdio？

• 可以使用支持HTTP通信的MCP Host應用程序。
• 或者使用node.js + mcp-remote解決方案：

npm install -g mcp-remote

在應用程序中配置類似以下內容：

{
    "servers": [
        {
            "name": "Siyuan",
            "key": "siyuan",
            "description": "讀取筆記",
            "command": "npx",
            "args": [
                "mcp-remote",
                "http://127.0.0.1:16806/sse"
            ],
            "isActive": true
        }
    ]
}

Q: 常見的MCP客戶端有哪些？

參考地址：https://github.com/punkpeye/awesome-mcp-clients 或 https://modelcontextprotocol.io/clients。

🙏 參考資料與致謝

部分依賴項已在package.json文件中列出。