Skip to content

Latest commit

 

History

History
194 lines (143 loc) · 8.57 KB

README.md

File metadata and controls

194 lines (143 loc) · 8.57 KB

WildFly MCP Server

A WildFly MCP server to integrate with your AI chatbot in order to interact with WildFly server using natural language. This MCP server is a Java quarkus fat jar application that you can configure in your chatbot mcp configuration.

This MCP server (a Tool in AI terminologie) helps you troubleshoot running WildFly servers using natural language. You can ask questions such as:

Hi, could you connect to the WildFly server running on host localhost and port 9990 with the user name admin and password admin and get the content of the log file, analyze it and check for errors?

Download the latest WildFly MCP binary

You can download it from: https://github.com/jfdenise/wildfly-mcp-server/releases/download/1.0.0.Alpha1/wildfly-mcp-server-1.0.0.Alpha1-runner.jar

Build WildFly MCP fat jar

Make sure to use JDK21+.

mvn clean install

Configure the chatbot

Add the following json to the chatbot configuration file:

{
  "mcpServers": {
    "wildfly": {
            "command": "java",
            "args": ["-jar",
                    "[path to the repository]/wildfly-mcp-server/target/wildfly-mcp-server-1.0.0.Final-SNAPSHOT-runner.jar"]
    }
  }
}

If you are using jbang, you can add the following json content:

{
  "mcpServers": {
    "wildfly": {
            "command": "jbang",
            "args": ["--quiet",
                    "org.wildfly:wildfly-mcp-server:1.0.0.Final-SNAPSHOT:runner"]
    }
  }
}

  • For claude.ai, on Fedora, add it to the file ~/.config/Claude/claude_desktop_config.json.

  • For MCPHost, add to a file named mcp.json and call: ./mcphost_Linux_x86_64/mcphost --config [path to the file]/mcp.json --model ollama:llama3.1:8b

Admin user credentials

The tools allow you to provide user name and password directly in your question. You can set the user name and password in the tool shell command using the system properties -Dorg.wildfly.user.name=<user name> and -Dorg.wildfly.user.password=<user password>

{
  "mcpServers": {
    "wildfly": {
            "command": "java",
            "args": ["-Dorg.wildfly.user.name=admin",
                     "-Dorg.wildfly.user.password=admin",
                     "-jar",
                     "[path to the repository]/wildfly-mcp-server/target/wildfly-mcp-server-1.0.0.Final-SNAPSHOT-runner.jar"]
    }
  }
}

Default WildFly server host and port

If no host is provided, localhost is used. If no port is provided, 9990 is used. You can configure default host and port using the system properties -Dorg.wildfly.host.name=<host name> and -Dorg.wildfly.port=<port>

Available Tools

getWildFlyStatus

Get the status of the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.
  • userName: The admin user name. Optional.
  • password: The admin user password. Optional.

getWildFlyConsumedMemory

Get the percentage of memory consumed by the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.

getWildFlyConsumedCPU

Get the percentage of cpu consumed by the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.

getWildFlyLogFileContent

Get the log file content of the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.
  • numberOfLines: The optional number of log file lines to retrieve. By default the last 200 lines are retrieved. Use -1 to get all lines.
  • userName: The admin user name. Optional.
  • password: The admin user password. Optional.

getWildFlyLoggingCategories

Get the list of the enabled logging categories for the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.
  • userName: The admin user name. Optional.
  • password: The admin user password. Optional.

enableWildFlyLoggingCategory

Enable a logging category for the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.
  • userName: The admin user name. Optional.
  • password: The admin user password. Optional.
  • loggingCategory: The logging category. Can be a high level category (such as security, web, http) or a specific logger (io.undertow).

disableWildFlyLoggingCategory

Disable a logging category for the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.
  • userName: The admin user name. Optional.
  • password: The admin user password. Optional.
  • loggingCategory: The logging category. Can be a high level category (such as security, web, http) or a specific logger (io.undertow).

getWildFlyPrometheusMetrics

Get the metrics (in prometheus format) of the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.

invokeWildFlyCLIOperation

Invoke a single WildFly CLI operation on the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.
  • userName: The admin user name. Optional.
  • password: The admin user password. Optional.

getWildFlyServerConfigurationFile

Gets the server configuration xml file content of the WildFly server running on the provided host and port arguments.

Inputs:

  • host: The host name on which the WildFly server is running. Optional, localhost is used by default.
  • port: The port the WildFly server is listening on. Optional, 9990 is used by default.
  • userName: The admin user name. Optional.
  • password: The admin user password. Optional.

Example of questions to ask to the WildFly server

Make sure to first start you WildFly sever.

Health and resource consumption

  • Hi, could you connect to the WildFly server and get the status of the server?
  • Hi, is the WildFly server activity normal?
  • Hi, could you connect again to the WildFly server and give me the status?
  • Hi, could you connect to the WildFly server running on localhost and port 7777 and get the status of the server?

Logging

  • Hi, could you connect to the WildFly server running on host localhost and port 9990 with the user name admin and password foo then enable the security logging?
  • Hi, could you connect to the WildFly server running on host localhost and port 9990 with the user name admin and password admin then enable the security logging?

Then attempt to connect to the server with invalid credentials, that the chatbot will analyze in the next question.

  • Hi, could you connect to the WildFly server and get the content of the log file, analyze it and check for errors?
  • Hi, could you disable the security logging?

Metrics

  • Could you retrieve the metrics of the WildFly server?
  • Hi, could you connect to the WildFly server and check the available memory and cpu usage?
  • Hi, could you connect to the WildFly server and check if it has enough available memory to run?
  • Hi, could you connect to the WildFly server and check if the cpu usage is not too high?