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 and get the content of the log file, analyze it and check for errors?

Using jbang

jbang, is the simplest way to use the WildFly MCP server.

Install jbang.
Add the WildFly MCP server configuration to your mcp client configuration, for example:

{
  "mcpServers": {
    "wildfly": {
            "command": "jbang",
            "args": ["-Dorg.wildfly.user.name=chatbot-user",
                     "-Dorg.wildfly.user.password=chatbot-user",
                     "org.wildfly.mcp:wildfly-mcp-server-stdio:1.0.0.Alpha3: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

NOTE: Make sure to have added a user that will be used by the MCP server to authenticate against the WildFly server. For example: $JBOSS_HOME/bin/add-user.sh -u chatbot-user -p chatbot-user

Installing via Smithery

To install WildFly MCP Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @wildfly-extras/wildfly-mcp-server --client claude

Admin user credentials

You can set the user name and password that you have been using to secure the WildFly server in the tool shell command using the system properties -Dorg.wildfly.user.name=<user name> and -Dorg.wildfly.user.password=<user password>

NOTE: When using the container image, WILDFLY_MCP_SERVER_USER_NAME and WILDFLY_MCP_SERVER_USER_PASSWORD env variables can be used.

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

NOTE: For SSE server, you can set the same system properties when starting the server.

Note on security

Allowing full access to your WildFly servers from the chatbot is not advised. Although you would then be able to call any WildFly management operations, it must be done carefully. In particular when the chat bot is connected to a public LLM, no sentive information should be exposed.

When the chat bot interacts with a locally managed model (e.g.: locally managed ollama model, the default), this is less of a problem.

In any case it is advised that you benefit from the WildFly RBAC configuration and define a user named chatbot-user with role Monitor.

Make sure to first add the user by invoking: $JBOSS_HOME/bin/add-user.sh -p chatbot-user -u chatbot-user

To enable RBAC, you can use the WildFly CLI command line and invoke the following commands:

/core-service=management/access=authorization:write-attribute(name=provider,value=rbac)
reload
/core-service=management/access=authorization/role-mapping=Monitor:add
/core-service=management/access=authorization/role-mapping=Monitor/include=chatbot-user:add(name=chatbot-user,type=USER)

When a user with the Monitor role is used, the following tools would fail:

enableWildFlyLoggingCategory tool.
disableWildFlyLoggingCategory tool.

In addition, write operations are not allowed when invoking the invokeWildFlyCLIOperation tool.

Note on sensitive information

Any sensitive information located in your server configuration file are not exposed when accessing to the server with the chatbot-user (actually any user with the Monitor role).
WildFly server doesn't log sensitive information. Make sure that the deployments running in the WildFly servers are not logging sensitive information that could be exposed.

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>

Configuring the WildFly MCP SSE server

The access to the WildFly MCP SSE server is secured with OIDC (OAuth2 'Resource Owner Password Credentials Grant').

In the following configuration (from the WildFly chat bot), a keycloak realm named wildfly-mcp-server that contains a client named token-service is used to authenticate users. The WildFly chatbot will prompt you for username and password that will then be used to retrieve Tokens from the keycloak server allowing to access to the SSE MCP server.

{
  "mcpSSEServers": {
    "wildfly": {
            "url": "http://localhost:8081/mcp/sse"
            "providerUrl": "http://localhost:8180/realms/wildfly-mcp-server",
            "clientId": "token-service"
    }
  }
}

WARNING: This configuration is subject to change once the Authorization specification draft is integrated in the MCP protocol specification.

SSE security token configuration

The Keycloak server URL, client and optional secret can be configured using the following system properties:

System property	Description
quarkus.oidc.auth-server-url	The URL to the keycloak server realm, default to `http://localhost:8180/realms/wildfly-mcp-server`
quarkus.oidc.client-id	The client id, default to `token-service`
quarkus.oidc.credentials.secret	The client secret, optional, default to `secret`

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.

getJVMInfo

Get the JVM (Java VM) information (version, input arguments, startime, uptime, consumed memory, consumed cpu) as JSON format. The Java VM is the one used to execute 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.

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.
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.
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.

getWildFlyServerConfiguration

Gets the server configuration in JSON 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.

browseDeployment

Get all the file paths contained inside a deployment deployed in the WildFly server running on the provided host and port arguments. The returned value is in JSON format.

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.
name: Optional deployment name. By default ROOT.war is used.

getDeploymentFileContent

Get the content of a file located inside a deployment deployed in 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.
name: Optional deployment name. By default ROOT.war is used.
path: Required path to the deployment content.

deployWildFlyApplication

Deploy an application to the WildFly server running on the provided host and port arguments. If an application with the same name already exists, it will be replaced.

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.
deploymentPath: Absolute path to the WAR file or exploded application directory. Required.
name: The deployment name. Optional, defaults to the last portion of the deploymentPath.
runtime-name: The runtime name for the deployment. Optional, defaults to the last portion of the deploymentPath.

undeployWildFlyApplication

Undeploy an application from the WildFly server running on the provided host and port arguments. If the application doesn't exist, an error is returned.

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.
name: The name of the deployment to undeploy.

shutdownServer

Shutdown a running server.

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.
timeout: The graceful timeout. Optional.

provisionWildFlyServerForDeployment

Provision a WildFly server or WildFly Bootable JAR by inspecting the content of a deployment. The deployment is then deployed to the server ready to be run.

Inputs:

deploymentPath: Absolute path to an existing deployment.
targetDirectory: Absolute path to a non existing directory. Note that the parent directory must exists.
addOns: A list of Glow AddOns to enable (WildFly CLI, openAPI, web console, ...). Optional.
serverVersion: The WildFly server version. Optional, by default the latest is used.
spaces: The enabled Glow spaces used to discover incubating features. Optional.
bootableJAR: Produce a WildFly bootable JAR. Optional.

getWildFlyProvisioningAddOns

List the WildFly add-ons (extra server features such as add-user.sh, jboss-cli.sh command lines, openAPI and more) that could be added when provisioning a WildFly server for the provided deployment. Inputs:

deploymentPath: Absolute path to an existing deployment.

getWildFlyDocumentationURL

Get WildFly documentation URL

Available prompts

Prompts are pre-built complex questions that you can invoke from your chat bot.

wildFly-prometheus-metrics-chart

Build a table and chart from WildFly prometheus metrics.

securityAudit

WildFly, security audit. Analyze the server log file for potential attacks.

wildFly-resources-consumption

WildFly and JVM resource consumption status. Analyze the consumed resources.

wildFly-deployment-errors

WildFly deployed applications, identify potential for errors.

wildfly-server-status

WildFly server, running status.

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 then enable the security logging?
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?

Build WildFly MCP quarkus uber jars

Make sure to use JDK21+.

mvn clean install

The STDIO based mcp server jar is stdio/target/wildfly-mcp-server-stdio-runner.jar. The SSE based mcp server jar is sse/target/wildfly-mcp-server-sse-runner.jar.

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

WildFly MCP Server

Using jbang

Installing via Smithery

Admin user credentials

Note on security

Note on sensitive information

Default WildFly server host and port

Configuring the WildFly MCP SSE server

SSE security token configuration

Available Tools

getWildFlyStatus

getJVMInfo

getWildFlyLogFileContent

enableWildFlyLoggingCategory

disableWildFlyLoggingCategory

getWildFlyPrometheusMetrics

invokeWildFlyCLIOperation

getWildFlyServerConfiguration

browseDeployment

getDeploymentFileContent

deployWildFlyApplication

undeployWildFlyApplication

shutdownServer

provisionWildFlyServerForDeployment

getWildFlyProvisioningAddOns

getWildFlyDocumentationURL

Available prompts

wildFly-prometheus-metrics-chart

securityAudit

wildFly-resources-consumption

wildFly-deployment-errors

wildfly-server-status

Example of questions to ask to the WildFly server

Health and resource consumption

Logging

Metrics

Build WildFly MCP quarkus uber jars