使用说明(Markdown 格式)

  • 项目简介

    • 该仓库实现了一个基于 Laravel 的 MCP 服务器,名称为 Memory Library,专注于“记忆/记忆库”的管理与查询。核心通过 MemoryLibraryServer 提供对资源(Resources)、工具(Tools)和提示(Prompts)的注册与暴露,供 MCP 客户端以标准化的 JSON-RPC 方式访问。
    • 服务器与嵌入向量、健康检查、以及异步处理等后台能力紧密集成,具备会话管理与权限控制能力,便于 LLM 客户端在对话中查询、记忆与执行外部功能。
  • 主要功能点

    • 资源(Resources):GetRecentMemory,提供最近记忆的摘要信息。
    • 工具(Tools):FetchMemory、SearchMemory、AddToMemory,用于读取、搜索和记忆的持久化操作。
    • 提示(Prompts):SummarizeRecentActivity,生成面向项目的活动摘要提示。
    • MCP 服务器主机:MemoryLibraryServer,定义服务器的名称、版本、整体指令与可暴露组件。
    • 嵌入与健康:嵌入驱动与健康检查机制(CloudFlare、OpenAI 等接口框架、ProviderHealth、EmbeddingJob 等模型健康与任务状态的管理)。
    • 安全与认证:结合 Laravel Passport、Fortify 的认证机制与两步验证支持,具备 token/OAuth 授权能力。
  • 安装与运行步骤(简要)

    1. 安装依赖
      • 通过 Composer 安装 PHP 依赖;通过 NPM/前端工具安装前端依赖并编译。
    2. 数据库与认证
      • 配置数据库连接,执行迁移,注册并配置 Passport 授权。
    3. 启动后端服务
      • 使用标准的 Laravel 启动方式运行应用,确保 /mcp 路径可访问,MCP 服务器端在内置命令下启动并监听请求。
    4. 配置 MCP 客户端
      • MCP 客户端需要配置连接参数(见下方服务器配置示例),以便通过 JSON-RPC 向 Memory Library 的 MCP 服务器发起请求并获取响应。
  • 服务器配置(给 MCP 客户端使用的连接信息,示例以 JSON 表述,字段含义在后文注释) { "server_name": "Memory Library", "command": "php", "args": ["artisan", "mcp:serve", "MemoryLibraryServer"] }

    配置字段说明(便于理解,不作为代码块展示)

    • server_name: MCP 服务器的显示名称,建议与代码中的 Memory Library 服务器名称保持一致,以便客户端用户识别。
    • command: 启动服务器所执行的命令,通常为 PHP 的 CLI 调用。
    • args: 启动命令的参数数组,指定要运行的 Artisan 入口以及目标服务器类名(MemoryLibraryServer),用于启动具体的 MCP 服务器实例。
    • 备注:实际客户端不需要编辑后端实现,只需要根据以上字段创建对等连接配置,后端将通过 JSON-RPC 提供资源、工具与提示的访问能力。
  • 基本使用方法

    • 启动后端后,MCP 客户端通过配置好的地址与服务器名称,发送标准的 MCP 请求,包含对 Resources、Tools、Prompts 的调用(如读取最近记忆、添加记忆、基于向量/文本的搜索、以及 SummarizeRecentActivity 的提示生成等)。
    • 客户端可以通过 JSON-RPC 访问服务器定义的能力,获得统一格式的响应与错误信息,便于将结果聚合到 LLM 的对话上下文中。

信息

分类

AI与计算