Memobase MCP Server 使用说明

项目简介

Memobase MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为大型语言模型 (LLM) 应用提供结构化的上下文数据访问和功能调用能力。该服务器主要提供用户和 Blob (二进制大对象,这里指代会话数据) 的管理功能,并以标准化的 MCP 协议与客户端进行通信。

主要功能点

  • 用户管理: 提供创建、查询、更新和删除用户的功能。
  • Blob 数据管理: 提供插入、查询和删除 Blob 数据的功能,Blob 数据用于存储会话信息。
  • 工具 (Tools): 注册并暴露了一系列工具,允许 LLM 客户端通过 'call_tool' 方法调用,执行用户和 Blob 数据的相关操作。
  • Stdio 传输协议: 使用标准输入/输出 (stdio) 作为默认的 MCP 通信协议,方便集成和部署。
  • JSON-RPC: 采用 JSON-RPC 2.0 协议进行客户端与服务器之间的通信。
  • 能力声明: 服务器启动时声明自身具备的工具能力,客户端可以通过 'list_tools' 方法获取。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的系统已安装 Node.js 和 npm (Node 包管理器)。
  2. 克隆仓库: 从 GitHub 克隆 'memodb-mcp' 仓库到本地。
    git clone https://github.com/wuyunmei/memodb-mcp.git
    cd memodb-mcp
  3. 安装依赖: 在仓库根目录下运行 npm install 命令安装项目依赖。
    npm install
  4. 构建项目: 运行 npm run build 命令编译 TypeScript 代码。
    npm run build

服务器配置

MCP 客户端需要配置以下信息以连接到 Memobase MCP Server。配置信息为 JSON 格式,通常在 MCP 客户端的配置文件中设置。

{
  "serverName": "memodb-mcp",  // MCP 服务器名称,可以自定义
  "command": "node",         // 启动 MCP 服务器的命令,这里使用 node 解释器
  "args": [                   // 启动命令的参数
    "dist/index.js"          //  指向编译后的服务器入口文件
  ],
  "transport": "stdio"       //  指定传输协议为 stdio
}

配置信息参数注释:

  • 'serverName': 服务器的名称,用于在客户端标识和管理不同的 MCP 服务器连接。可以根据实际情况自定义,例如 "memobase_server"。
  • 'command': 启动服务器进程的命令。由于本项目是 Node.js 应用,所以这里使用 'node' 命令来运行 JavaScript 文件。
  • 'args': 传递给启动命令的参数,以数组形式表示。'"dist/index.js"' 指定了编译后的服务器入口文件路径。请确保该路径相对于 MCP 客户端的运行环境是正确的。
  • 'transport': 指定 MCP 服务器使用的传输协议。本项目使用标准输入/输出流 ('stdio') 进行通信。

基本使用方法

Memobase MCP Server 运行后,会监听标准输入 (stdin) 接收来自 MCP 客户端的 JSON-RPC 请求,并通过标准输出 (stdout) 返回 JSON-RPC 响应。

1. 启动服务器 在仓库根目录下,运行以下命令启动 Memobase MCP Server:

npm run start

服务器成功启动后,会在控制台输出 'Memobase MCP server running on stdio'。

2. 与服务器交互 (通过 MCP 客户端) MCP 客户端需要按照 MCP 协议格式发送 JSON-RPC 请求到服务器的标准输入,并解析服务器在标准输出返回的 JSON-RPC 响应。

示例请求 (ListToolsRequest): 获取服务器支持的工具列表

{"jsonrpc": "2.0", "method": "list_tools", "params": {}}

示例请求 (CallToolRequest): 调用 'create_user' 工具创建用户

{"jsonrpc": "2.0", "method": "call_tool", "params": {"name": "create_user", "arguments": {"name": "test_user"}}}

注意: 实际使用时,你需要使用实现了 MCP 客户端协议的 LLM 应用或客户端库来与 Memobase MCP Server 进行交互。客户端库会负责构建和发送符合 MCP 协议的 JSON-RPC 请求,并处理服务器返回的响应。

信息

分类

数据库与文件