使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,它将 Memos 笔记服务的功能通过 MCP 协议暴露出来。通过此服务器,LLM 应用可以方便地调用 Memos 的 API,实现笔记的搜索和创建,从而集成个人知识库到 LLM 应用的工作流程中。

主要功能点

  • 搜索 Memos 笔记:允许 LLM 应用根据关键词搜索 Memos 笔记的内容,并将搜索结果作为上下文信息使用。
  • 创建 Memos 笔记:允许 LLM 应用快速创建新的 Memos 笔记,方便记录和保存 LLM 交互过程中的重要信息或想法,并支持添加自定义标签和默认标签。

安装步骤

  1. 环境准备:确保您的环境中已安装 Python 3.7 或更高版本。
  2. 下载代码:将此仓库的代码克隆到本地。
  3. 安装依赖:在代码根目录下,使用 pip 安装所需的依赖库:
    pip install fastmcp requests
  4. 配置环境变量
    • 'MEMOS_URL': 您的 Memos 服务 API 地址,例如 'https://your-memos-instance.com'。
    • 'MEMOS_API_KEY': 用于访问 Memos API 的密钥。您需要在 Memos 后台的用户设置中创建 API 密钥。
    • 'DEFAULT_TAG' (可选): 您希望在创建笔记时自动添加的默认标签,例如 '#LLM' 或 '#MCP'。如果未设置,默认为 '#MCP'。 您可以通过 export 命令或者修改 '.bashrc' / '.zshrc' 文件来设置这些环境变量。

服务器配置

MCP 客户端需要以下 JSON 格式的配置信息来连接到本 MCP 服务器:

{
  "server_name": "memos",
  "command": "python",
  "args": ["main.py"],
  "transport": "stdio"
}
  • 'server_name': 服务器的名称,可以自定义,用于在 MCP 客户端中标识不同的服务器连接。
  • 'command': 启动 MCP 服务器的命令,这里使用 'python' 解释器来运行 'main.py' 脚本。
  • 'args': 传递给启动命令的参数,这里指定要运行 'main.py' 文件。
  • 'transport': MCP 服务器使用的传输协议,本项目使用 'stdio',即标准输入输出流进行通信。

基本使用方法

  1. 启动服务器:在安装完成并配置好环境变量后,在代码根目录下运行 'python main.py' 命令来启动 MCP 服务器。服务器将通过标准输入输出与 MCP 客户端进行通信。
  2. 配置 MCP 客户端:在您的 MCP 客户端应用中,根据上述【服务器配置】部分的信息,配置一个新的服务器连接。
  3. 调用工具:在 LLM 应用中,您可以通过 MCP 客户端向 'memos' 服务器发送请求,调用 'search_memos' 工具进行笔记搜索,或调用 'create_memo' 工具创建新的笔记。工具的具体参数和返回值请参考代码中的函数签名和注释。

信息

分类

生产力应用