f5xc-api-mcp

  • 项目简介

    • 该仓库实现了一个基于 MCP(Model Context Protocol)的后端服务器,旨在向大型语言模型(LLM)提供结构化的上下文信息、对外部工具的调用能力、以及可渲染的提示模板。核心功能包括资源管理、工具注册与执行、以及提示模板的定义与渲染,所有通信均区分为文档模式与执行模式,以支持安全、可扩展的上下文服务。
  • 主要功能点

    • 资源管理与数据访问:托管并管理多种资源类型,提供统一的数据访问能力。
    • 工具注册与执行:注册可调用的外部工具,并在 MCP 服务器端执行对应的 API 调用。
    • 提示模板与工作流:定义和渲染提示模板,支持自定义的 LLM 交互模式,便于对话生成与工作流执行。
    • JSON-RPC 通信:与 MCP 客户端使用标准的 JSON-RPC 请求/响应模式进行交互。
    • 会话与能力声明:服务器端管理会话状态、能力(功能声明)以及权限模式(文档模式 vs 执行模式)。
    • 多传输协议支持:内建对 Stdio、SSE、WebSocket 等传输方式的支持,提升灵活性和整合能力。
    • 安全与可扩展性:支持多种认证方式、配额、以及对新域/资源/工具的扩展能力。
    • 自动化文档与工具索引:基于 enrich/OpenAPI 规范生成的工具、域、资源文档及索引。
  • 安装步骤

    • 克隆仓库到本地
    • 安装依赖并构建项目
    • 运行构建输出,启动 MCP 服务器
  • 服务器配置(给 MCP 客户端的启动配置信息) { "serverName": "f5xc-api-mcp", "command": "npx", "args": ["@robinmordasiewicz/f5xc-api-mcp"], "environment": { "F5XC_API_URL": "https://your-tenant.console.ves.volterra.io", "F5XC_API_TOKEN": "<your-api-token>" } // 说明 // - serverName:服务器标识名称,便于在客户端配置中引用 // - command/args:用于启动 MCP 服务器的命令及参数(客户端需要提供此信息以连接服务器) // - environment:运行所需的环境变量(如后端 API 的访问地址及令牌等) }

  • 基本使用方法

    • 在 Claude、VS Code 及其他 MCP 客户端中,将上方配置作为本地 MCP 服务器的连接源
    • 启动 MCP 服务器后,客户端可通过 JSON-RPC 调用读取资源、执行工具、获取提示模板等
    • 根据需要切换到执行模式以实际调用后端 F5XC API,或保持文档模式进行阅读与探索
    • 使用内置的工作流 prompts 与工具索引,提升对话的上下文能力与自动化水平
  • 运行注意

    • 如需执行模式,请提供有效的 API URL 与 Token,并确保后端权限配置允许对应操作
    • 在多域/资源场景下,确保客户端的请求参数与 MCP 服务器的资源/工具对齐

服务器信息