PatternFly MCP Server

PatternFly MCP服务器

一个模型上下文协议（MCP）服务器，提供对PatternFly规则和文档的访问，使用Node.js构建。

PatternFlyMCP服务器是PatternFly的综合库资源。 它旨在可扩展以满足不同团队和项目的需求，从简单到复杂，从设计到开发。 在架构文档中阅读更多关于我们的路线图以及我们如何构建服务器的信息.

需求

• NPM（或等效的包管理器）

快速启动

PatternFly MCP服务器支持多种配置；看 使用文档 了解详情。

与IDE集成使用

设置基本MCP配置

最小配置

{
  "mcpServers": {
    "patternfly-mcp": {
      "command": "npx",
      "args": ["-y", "@patternfly/patternfly-mcp@latest"],
      "description": "PatternFly rules and documentation"
    }
  }
}

HTTP传输模式

{
  "mcpServers": {
    "patternfly-mcp": {
      "command": "npx",
      "args": ["-y", "@patternfly/patternfly-mcp@latest", "--http", "--port", "8080"],
      "description": "PatternFly rules and documentation (HTTP transport)"
    }
  }
}

有关更多示例，请参阅MCP服务器配置文档。

用于开发、高级使用

运行最新发布的服务器

立即通过运行最新发布的包 npx:

npx -y @patternfly/patternfly-mcp@latest

或带有选项

npx -y @patternfly/patternfly-mcp@latest --log-stderr --verbose

运行本地构建的服务器

# clone the repo, change the directory, npm install, npm run build, then in the repo context run...
npm start

检查服务器

可视化并测试打包的MCP接口：

npx -y @modelcontextprotocol/inspector npx -y @patternfly/patternfly-mcp@latest

从源代码构建并测试本地构建的MCP接口：

# clone the repo, change the directory, npm install, npm run build, then in the repo context run...
npx -y @modelcontextprotocol/inspector node dist/cli.js

将服务器嵌入到您的应用程序中

import { start } from '@patternfly/patternfly-mcp';

// Remember to avoid using console.log and info, they pollute STDOUT
async function main() {
  const server = await start();

  // Graceful shutdown
  process.on('SIGINT', async () => {
    await server.stop();
    process.exit(0);
  });
}

main();

有关其他示例、CLI和嵌入式服务器选项，请参阅开发文档。

文档

用于综合使用、开发和项目状态 阅读文档.

• 建筑：了解我们的 混合文档概念和数据源.
• 用法：详细指南 通用的内置工具、资源和故障排除.
• 发展：参考 CLI选项和工具插件.

贡献

贡献？指南可以在这里找到 贡献.md.

AI 代理

如果您正在使用AI助手来帮助此存储库中的开发，请提示它 review the repo guidelines 确保遵守项目惯例。

开发人员与代理交互的指南可以在 贡献.md.