使用说明
项目简介
WildFly MCP Server 是一个 MCP 服务器实现,它扩展了 WildFly 应用服务器的功能,使其可以通过自然语言进行交互。该服务器提供了一系列工具和 Prompt,允许用户使用 AI 聊天机器人以更便捷的方式管理和监控 WildFly 服务器。
主要功能点
- 资源管理 (Resources): 虽然仓库信息中没有明确提及资源管理,但通过与 WildFly 管理 API 交互,服务器实际上是在管理 WildFly 服务器的各种配置和运行时信息,这些可以被视为广义上的“资源”。
- 工具注册和执行 (Tools): 提供了丰富的工具集,允许 LLM 客户端调用来执行 WildFly 服务器的管理操作,例如:
- 获取 WildFly 服务器的日志类别列表
- 获取 WildFly 服务器配置 (JSON 格式)
- 执行 WildFly CLI 操作
- 启用/禁用 WildFly 日志类别
- 获取 WildFly 日志文件内容
- 获取 WildFly 服务器状态 (包括内存和 CPU 使用率)
- 获取 WildFly Prometheus 指标
- Prompt 模板定义和渲染 (Prompts): 预定义了 Prompt 模板,例如用于获取 Prometheus 指标图表和进行安全审计,方便用户快速发起特定类型的管理任务。
安装步骤
由于该仓库是 WildFly 生态系统的一部分,并且基于 Quarkus 构建,其安装和部署通常涉及 Java 和 WildFly 环境。以下是简要的安装步骤:
-
克隆仓库: 从 GitHub 克隆 'wildfly-extras/wildfly-mcp' 仓库到本地。
git clone https://github.com/wildfly-extras/wildfly-mcp.git cd wildfly-mcp/wildfly-mcp-server -
构建项目: 使用 Maven 构建项目。
mvn package构建成功后,你会在 'wildfly-mcp-server/target' 目录下找到构建产物,例如 'wildfly-mcp-server-runner.jar'。
-
部署运行: 该 MCP Server 可以作为一个独立的 Java 应用运行,或者部署到 WildFly 服务器中。
独立运行 (推荐): 确保已安装 JDK 17+,然后使用以下命令运行 JAR 文件:
java -jar target/wildfly-mcp-server-runner.jar部署到 WildFly (高级): 可以将构建出的 JAR 文件部署到 WildFly 服务器的 deployments 目录下,但这可能需要额外的 WildFly 配置。建议独立运行以简化部署。
服务器配置
MCP 客户端需要配置与 WildFly MCP Server 连接的信息。以下是一个 JSON 格式的配置示例,用于 MCP 客户端连接到该服务器:
{ "servers": { "wildfly-mcp": { "type": "stdio", "command": "java", "args": [ "-jar", "/path/to/wildfly-mcp-server-runner.jar" // 请替换为实际的 JAR 文件路径 ] } } }
配置参数说明:
- 'servers': 定义可用的 MCP 服务器列表。
- 'wildfly-mcp': 自定义的服务器名称,用于在客户端中引用。
- 'type': 连接类型,这里使用 'stdio' (标准输入输出) 协议。
- 'command': 启动 MCP 服务器的命令,通常是 'java'。
- 'args': 传递给启动命令的参数列表:
- '"-jar"': 指定运行 JAR 文件。
- '"/path/to/wildfly-mcp-server-runner.jar"': [请替换为实际的 'wildfly-mcp-server-runner.jar' 文件在您系统中的绝对路径。] 这是构建步骤中生成的 JAR 文件路径。
注意: 实际的 JAR 文件路径 '/path/to/wildfly-mcp-server-runner.jar' 需要根据你的实际构建输出路径进行调整。
基本使用方法
- 启动 WildFly MCP Server: 根据上面的安装步骤启动 WildFly MCP Server。
- 配置 MCP 客户端: 在 MCP 客户端 (例如 WildFly Chat Bot 或其他兼容 MCP 协议的客户端) 中,配置上面提供的 JSON 信息,指定连接到 WildFly MCP Server。
- 使用客户端与 WildFly 服务器交互: 通过 MCP 客户端,你可以使用自然语言指令与 WildFly 服务器进行交互,例如:
- 询问服务器状态: “What is the status of the WildFly server?”
- 获取日志文件: “Get the latest 100 lines of the server log file.”
- 启用特定日志类别: “Enable logging for security category.”
客户端会将你的自然语言指令转换为 MCP 请求发送给 WildFly MCP Server,服务器会调用相应的工具与 WildFly 服务器交互,并将结果返回给客户端。
信息
分类
开发者工具