GuardKit MCP Server (Python 模板实现)

使用说明(Markdown 格式)

  • 项目简介

    • GuardKit 的 MCP 服务器模板,旨在为 LLM 客户端提供可扩展的上下文服务。核心能力包括托管资源(数据读取)、注册与执行工具(外部功能调用)、以及可自定义的 Prompt 模板渲染。
  • 主要功能点

    • 资源管理:暴露数据资源供 LLM 客户端读取与查询。
    • 工具注册与执行:注册工具,LLM 能调用外部功能;工具实现支持参数类型转换与结果元数据。
    • Prompt 模板:提供可渲染的提示模板,支持自定义对话模式。
    • MCP 通信:通过 JSON-RPC 与客户端通信,服务器返回响应或通知。
    • 会话与能力声明:提供会话管理、能力声明,并支持多传输协议。
    • 安全与扩展:设计为可扩展的后端框架,便于接入认证、资源保护与多语言插件。
  • 安装步骤

    • 确保运行环境为 Python3 及以上,安装必要的 MCP 库与依赖(示例中使用 FastMCP 组件来实现 MCP 协议处理)。
    • 下载/克隆仓库后,进入模板目录:templates/mcp-server-python
    • 安装依赖并准备运行环境(根据实际运行环境选择虚拟环境管理工具,如 venv、poetry、pipenv 等)。
    • 启动服务器(示例入口在代码中以 FastMCP 为核心,默认通过标准输入输出传输进行会话)。实际运行请参考模板中的入口点设置。
  • 服务器配置(面向 MCP 客户端) 说明:MCP 客户端需要一个 JSON 配置来连接服务器。以下字段为示意描述,具体内容请按客户端实现约定编排。配置为 JSON 结构,包含:

    • server_name: 服务器名称,用于标识该 MCP 服务
    • command: 启动服务器的命令
    • args: 启动参数数组 注释说明:客户端并不需要具备服务器端的具体实现细节,仅通过此配置知道如何启动并连接到服务器。示例字段与实际 CLI 入口点相关,请按照客户端实际需要进行配置。
  • 基本使用方法

    • 启动后,MCP 客户端可通过标准 JSON-RPC 请求向服务器读取资源、调用工具、获取 Prompt 及其他能力声明。
    • 工具的注册与执行、资源访问等通过定义的 MCP 接口进行,服务器端负责执行与返回结果,并处理会话和权限控制。

服务器信息