HCC PatternFly MCP 服务器

使用说明(Markdown格式)

  1. 项目简介
  • 本仓库包含一个基于 MCP 的服务器实现(HCC PatternFly MCP 服务器),以及一组为前端开发场景设计的工具和服务。这些工具支持向 LLM 客户端提供 PatternFly 组件描述、实现示例、可用模块、组件源代码以及 PatternFly CSS 工具等能力,帮助在开发工作流中实现更智能的上下文查询与功能调用。
  1. 主要功能点
  • 提供描述工具:获取 PatternFly DataView 相关能力的简要描述与要点。
  • 实现示例工具:提供 PatternFly 数据视图相关实现示例的文本内容。
  • 模块发现工具:列出本地环境中可用的 PatternFly 模块名称。
  • 组件源代码工具:在当前环境中定位并返回指定 PatternFly 组件的源码文件内容。
  • React 样式工具:获取 PatternFly 样式工具集的 CSS 内容(如数据视图相关的样式)。
  • MCP 服务器接口:通过 MCP 服务器注册这些工具,进行参数校验、返回 MCP 格式的文本内容。
  • 传输与扩展性:支持多种传输协议(如 Stdio)并具备会话管理与能力声明,便于后续扩展更多工具与资源。
  1. 安装步骤
  • 将仓库克隆到本地或服务器上,并进入该 MCP 服务器子目录进行设置与构建。
  • 安装依赖:在包含 MCP 服务器的目录下执行依赖安装,确保 Node 环境就绪。
  • 构建打包:编译生成可执行的服务器入口文件(通常输出到 dist/ 等目录)。
  • 启动服务器:以打包后的文件为入口启动 MCP 服务器,使其监听标准输入/输出等传输通道,准备接受来自 MCP 客户端的请求。
  1. 服务器配置(MCP 客户端所需信息,不需要额外客户端代码) 以下 JSON 示例描述了如何在 MCP 客户端配置该 MCP 服务器以便连接与使用: { "mcpServers": { "mcp-patternfly": { // 启动该 MCP 服务器的命令 "command": "node", // 启动参数,指向打包后的服务器入口文件(实际路径请按构建产物位置填写) "args": [ "dist/index.js" ], // 如有需要可设置环境变量,示例注释中给出字段名,实际使用时可省略 "env": { // 例如: "PATTERNFLY_ENV": "production" } } } } 说明:
  • serverName 对应 MCP 服务器在你的环境中的标识名称,这里对应 "mcp-patternfly"。
  • command 与 args 指定如何在你的运行环境中启动服务器进程。
  • 该配置仅用于 MCP 客户端的连接信息;MCP 客户端本身不需要实现服务器端逻辑,只需要知道如何启动与连接到服务器即可。
  1. 基本使用方法
  • 启动后与 MCP 客户端建立连接(JSON-RPC 形式的请求/响应),客户端可以通过以下能力访问本 MCP 服务器提供的工具:描述、实现示例、可用模块、组件源码、CSS 工具等。
  • 客户端调用示例(描述性说明,不包含代码):
    • 调用方式:向 MCP 服务器发送包含工具名称、参数的请求,服务器返回结构化的文本内容或错误信息。
    • 工具名称示例:getPatternFlyDataViewDescription、getPatternFlyDataViewExample、getAvailableModules、getComponentSourceCode、getReactUtilityClasses 等。
    • 参数说明:具体工具所需参数见工具的输入模式(如 componentName、packageName、exampleName 等)。
  • 运行与调试:
    • 确认服务器已正确启动并可被客户端访问。
    • 通过 Claude Code 插件或自建客户端进行测试调用,验证返回的 content 内容为文本型数据且符合工具定义的格式要求。
    • 如遇到问题,可查看 MCP 服务器日志、确认传输通道(如 Stdio)配置正确,以及工具注册项是否按预期完成。
  1. 使用时的注意事项
  • MCP 服务器在启动时需正确暴露其工具集合以及能力,确保客户端能够通过 JSON-RPC 调用到相应工具。
  • 当前实现的工具聚焦于 PatternFly 组件生态,便于在前端开发场景中获取文档、源码与示例等信息。
  • 若需扩展,请在服务器端添加新的工具定义、注册到 MCP 服务器实例,并按现有工具格式进行实现与测试。
  1. 参考与扩展
  • 该仓库还包含大量针对工具的单元测试、Mocks、以及实现细节,帮助保证 MCP 服务在不同场景下的稳定性与可维护性。
  1. 关键词 PatternFly, 前端开发, 模块发现, 组件源码, 数据视图, 样式工具

  2. 分类ID 6

服务器信息