使用说明(简明版本,便于快速落地)

  • 项目简介

    • y-gui 的后端核心包含对 MCP 服务器的注册、管理、工具执行与提示渲染等能力,旨在为 MCP 客户端提供一致的上下文信息、资源访问和工具执行能力,并通过流式输出与客户端进行交互。
  • 主要功能点

    • MCP 服务器管理:注册、更新、删除 MCP 服务器配置,缓存服务器状态与可用工具。
    • 工具执行与工具提示:在需要时就近连接 MCP 服务器,查询可用工具并执行,返回分块内容。
    • Prompt 渲染:基于当前已连接的 MCP 服务器状态,动态渲染用于 LLM 的 Prompt 模板。
    • 会话与数据存储:通过 D1、R2、KV 等 Cloudflare 存储后端,保持会话、机器人配置及集成信息。
    • 安全与集成:提供 OAuth、Key 认证等集成入口,支持多来源集成(如 Gmail、日历、图像生成等)。
    • 流式输出与块传输:对于工具执行与对话输出,支持分块推送给 MCP 客户端,提升实时性。
  • 安装步骤(简要)

    1. 准备环境
      • Cloudflare 帐号与 Wrangler/Workers‑.dev 环境
      • Cloudflare D1、R2、KV 等存储配额与密钥
      • 如使用 Google 集成,需要 Google OAuth 相关凭据
    2. 部署前配置
      • 配置后端环境变量(如 MCP_SERVER_URL、OPENROUTER_BASE_URL、OPENROUTER_FREE_KEY、GOOGLE_CLIENT_ID、GOOGLE_CLIENT_SECRET 等)
      • 配置 Wrangler/Wrangler.toml 与相关绑定
    3. 部署
      • 将后端代码部署到 Cloudflare Workers
      • 根据需要启用前端与后端的协同访问
    4. 运行与验证
      • 使用 MCP 客户端连接指定 MCP 服务器,查询工具、资源并执行
      • 查看服务器端的工具提示、日志与状态输出
  • 服务器配置(MCP 客户端需要的配置信息示例) 下面的配置示例以 JSON 格式给出,描述了 MCP 服务器的名称、启动命令及参数(客户端启动时需要该信息来连接 MCP 服务器)。请将以下信息按你的实际地址和需求进行替换。MCP 客户端不直接需要代码实现,只需知道要连接的服务器名称及启动参数即可。

{ "servers": [ { "name": "default", "command": "start-mcp-server", "args": [ "--url", "https://your-mcp-server.example.com", "--token", "<可选的访问令牌>" ] }, { "name": "gmail-mcp", "command": "start-mcp-server", "args": [ "--url", "https://gmail-mcp.example.com", "--token", "<GMAIL 集成访问令牌>" ] } ] }

  • 基本使用方法
    • 连接与确认
      • 在 MCP 客户端提供的启动配置中填入服务器名称与启动参数,启动后客户端应能与 MCP 服务器建立连接。
    • 查询工具并执行
      • 客户端向 MCP 服务器请求工具列表,服务器返回可用工具及输入签名,客户端选择工具执行。
    • 渲染 Prompts
      • MCP 服务器根据当前连接状态渲染 Prompt 模板,客户端在对话中可直接获得上下文与工具可用性信息。
    • 会话管理
      • 服务器端维护会话状态、连接状态及最近更新,便于跨会话的上下文管理与工具执行记录。

信息

分类

AI与计算