Grimoire MCP 服务器(Grimoire-kit 集成)

使用说明(Markdown 格式)

  • 项目简介

    • Grimoire MCP 服务器是 Grimoire-kit 提供的后端组件之一,旨在以标准化的 MCP 协议向 LLM 客户端提供上下文信息、访问资源、注册和执行工具,以及定义与渲染 Prompt 模板等能力,帮助 LLM 客户端在本地 IDE/编辑器中获得一致且可扩展的上下文服务。
  • 主要功能点

    • 资源、工具、提示模板的托管与管理
    • 注册并执行 Tools,LLM 可以通过 MCP 调用外部功能
    • 提供对 Prompt 模板的定义与渲染支持
    • 通过 JSON-RPC 与客户端通信,支持会话管理与能力声明
    • 支持多种传输协议(如 Stdio、SSE、WebSocket,视具体实现可选)
    • 具备安全性功能,例如输入清洗、速率限制等以保护服务器
  • 安装步骤

    • 安装 Grimoire-kit(包含 MCP 组件)
    • 运行 MCP 服务脚本,启动 Grimoire 的 MCP 服务端实现
    • 根据需要选择传输模式(如 stdio、SSE 等)启动参数
  • 服务器配置(MCP 客户端连接信息) 说明:MCP 客户端需要使用一个配置来连接到服务器。配置示例以 JSON 表示,包含服务器名称、启动命令与参数,以及工作目录等元信息。请在你的 MCP 客户端中将以下信息替换成实际部署路径与项目根目录: { "server_name": "grimoire", "command": "python3", "args": ["/path/to/grimoire-kit/framework/grimoire-mcp-tools.py"], "env": { "Grimoire_PROJECT_ROOT": "/path/to/your/project" }, "transport": "stdio" // 也可选 "sse"、"websocket" 等,根据实际环境配置 }

  • 基本使用方法

    • 启动与连接:按照上面的配置在 MCP 客户端中注册服务器信息,然后通过 MCP 客户端发起请求,请求格式遵循 MCP 的 JSON-RPC 规范,服务端返回相应的 JSON-RPC 响应或通知。
    • 功能调用:客户端可通过调用暴露的 Tools、获取资源上下文、执行工作流等能力来与 Grimoire 的后端进行交互。
    • 安全与可扩展性:服务器端实现包含输入清洗、速率限制等机制,支持动态发现工具并暴露为 MCP Tool,便于 IDE 集成与自定义扩展。
  • 备注

    • 具体命令、路径与环境变量需结合实际部署环境进行配置,确保 Grimoire 项目根路径和 MCP 客户端配置中的路径一致性。

服务器信息