项目简介

该项目是思源笔记（SiYuan Note）的一个插件，实现了Model Context Protocol (MCP) 服务器功能。它允许遵循MCP协议的LLM（大型语言模型）客户端与思源笔记进行交互，获取笔记中的上下文信息，并调用预定义的功能（工具）。

主要功能点

• 思源笔记内容访问： 提供访问思源笔记中数据的能力，包括根据ID读取文档的Kramdown内容，以及执行全文搜索和自定义SQL查询来查找和检索信息。
• 工具调用： 支持调用预定义的操作工具，例如：
  • 日记追加： 将Markdown格式的内容追加到当天的日记中。
  • 文档追加： 将Markdown格式的内容追加到思源笔记中指定ID的文档末尾。
  • 笔记本列表： 获取思源笔记中所有笔记本的详细信息列表。
• LLM交互支持： 通过提供结构化的工具定义和数据访问接口，支持LLM客户端构建更智能、上下文感知的交互，例如基于笔记内容回答问题或执行笔记编辑操作。

安装步骤

1. 通过应用集市安装 (推荐): 在思源笔记的应用集市中搜索“MCP”或“MCP服务器”找到本插件，并直接安装。
2. 手动安装:
   • 从本项目的Release页面下载 'package.zip' 文件。
   • 解压 'package.zip'。
   • 将解压后的文件夹移动到您的思源笔记工作空间的 'data/plugins/' 目录下。
   • 将该文件夹重命名为 'syplugin-anMCPServer'。
3. 启用插件: 在思源笔记中打开设置 -> 插件，找到“SiYuan MCP服务器”并启用。
4. 配置服务器: 插件默认在 '127.0.0.1:16806' 启动MCP服务器。您可以在插件设置中修改监听端口和设置是否随思源笔记自启动。

服务器配置 (供MCP客户端使用)

本MCP服务器使用SSE（Server-Sent Events）作为传输协议。您需要在兼容MCP协议的LLM客户端或MCP Host应用的配置中添加一个新的服务器连接。以下是配置的关键信息：

• 类型 (type): 必须设置为 'sse'。
• 连接命令/地址 (command): 必须设置为服务器监听的SSE端点地址。如果您使用了默认设置，则地址为 'http://127.0.0.1:16806/sse'。如果修改了端口，请使用对应的端口号。
• 参数 (args): 通常为一个空数组 '[]' 或根据客户端要求设置。
• 服务器名称 (server name): 在客户端中为此连接起一个标识名称，例如 'siyuan'。

请参考您使用的MCP客户端或MCP Host应用的具体文档，将上述信息填入其服务器配置中。

基本使用方法

配置并连接成功后，您的LLM客户端即可通过MCP协议与思源笔记进行通信。LLM可以：

• 利用服务器提供的工具（如搜索、SQL查询）获取思源笔记中的相关笔记内容或数据，作为回答用户问题或完成任务的上下文信息。
• 调用写入工具（如追加到日记、追加到文档）将LLM生成的文本保存到思源笔记中。
• 调用其他工具（如列出笔记本、读取文档内容）来辅助完成更复杂的任务。

具体如何利用这些能力取决于您使用的LLM客户端的功能支持以及如何设计Prompt来引导LLM使用这些工具和获取上下文。