PatternFly MCP Server

关键词

Model Context ProtocolPatternFly 资源工具注册与调用提示模板渲染多传输协议

Markdown 使用说明

项目简介

  • PatternFly MCP Server 是一个完整的 Model Context Protocol（MCP）后端实现，旨在以标准化的 JSON-RPC 方式向大语言模型（LLM）客户端提供 PatternFly 相关资源、可调用的工具、以及可渲染的提示模板等上下文信息。服务器负责会话管理、能力声明，并支持多种传输协议。

主要功能点

  • 资源管理：托管并管理 PatternFly 的文档、模板与组件等资源，支持资源列表、读取与模板渲染等操作。
  • 工具注册与执行：提供内置工具、外部插件工具与内联工具的注册、发现、调用与返回结果的完整流程，包含参数校验、错误处理与跨进程工具主机（Tools Host）支持。
  • 提示模板渲染：支持模板化的文档与组件信息渲染，便于 LLM 通过统一接口获取可用的 Prompt 内容。
  • JSON-RPC 通信：服务器端实现 MCP 的核心请求/响应逻辑，处理诸如 resources/list、resources/read、tools/list、tools/call、模板/模板读等 JSON-RPC 请求。
  • 会话与能力声明：为每次连接维护会话上下文，按需声明能力（如 logging、transport 等），并支持协议日志、健康与统计上报。
  • 多传输协议支持：默认 STDIO 传输，亦可通过 HTTP/WS/ SSE 等传输方式实现，便于在 IDE、异步服务或网络环境中集成。
  • 安全与扩展性：对外部工具采用沙箱化与权限控制，提供工具主机隔离选项，以及对文件系统读取、URL 加载的可配置白名单机制。

安装与运行

  • 环境要求：Node.js 20+，NPM（或等效包管理器）。
  • 快速入门（命令行运行）
    • 使用 npx 直接启动 MCP 服务器，快速体验模式：npx -y @patternfly/patternfly-mcp
    • 也可以嵌入应用中，作为后端服务集成到现有系统。

服务器配置（给 MCP 客户端使用的配置示例，客户端无需直接执行代码） { "mcpServers": { "patternfly-docs": { "command": "npx", "args": ["-y", "@patternfly/patternfly-mcp@latest"], "description": "PatternFly rules and documentation" } // 如需开启 HTTP/端口访问，可在 args 中添加 --http --port 8080 等选项 } } 说明：以上配置用于 MCP 客户端在集成阶段通过启动外部 MCP 服务器来提供服务。客户端会通过指定的 name 与 command/args 启动服务器并建立通信通道。实际运行时，请确保 Node 环境已具备所需权限与网络访问。

基本使用方法（简要操作步骤）

  • 启动服务器
    • 直接运行 MCP 服务器（本仓库提供的入口可以直接通过 npx 启动，或在嵌入在应用中使用 start 函数）。
  • 连接与交互
    • 通过 JSON-RPC 方式向服务器发出请求，例如查询可用工具、读取资源、调用工具、获取文档等。
    • 服务器返回标准的 MCP JSON-RPC 响应，客户端可据此进行后续处理。
  • 使用示例场景
    • 查询内置工具与资源清单
    • 读取文档资源并渲染提示模板
    • 调用工具以获取计算结果或文档摘要
    • 与不同传输模式（如 STDIO、HTTP）集成并测试通信
  • 部署与扩展
    • 可以在工具主机（Tools Host）中加载外部工具插件，支持 inline、文件/包形式的工具配置
    • 支持自定义工具、模板与文档资源的拓展

关键词 Model Context Protocol, PatternFly 资源, 工具注册与调用, 提示模板渲染, 多传输协议

分类ID 6

服务器信息

访问项目