This section describes how to integrate Jtest's MCP (Model Context Protocol) server with AI coding agents, such as GitHub Copilot and Codex CLI.
The MCP server exposes Jtest's capabilities — including static analysis rule documentation, violation reporting, and Jtest's feature documentation — directly to AI assistants, enabling context-aware code assistance driven by Jtest analysis results.
The MCP server is located at <INSTALL_DIR>/integration/mcp/.
Prerequisites:
Jtest is installed.
- Java is available (the launcher uses Jtest's bundled JRE automatically).
Running the MCP Server Launcher
Run the MCP launcher script for your platform:
- Windows:
<INSTALL_DIR>/integration/mcp/jtestmcp.bat - Linux/macOS:
<INSTALL_DIR>/integration/mcp/jtestmcp
When launched, the MCP server starts a local process that communicates over stdio using the Model Context Protocol. The coding agent connects to it and gains access to the following tools:
Search Jtest documentation — queries Jtest feature docs bundled in
jtest-ai-docs.zip- Get static analysis rule documentation — retrieves detailed documentation for specific Jtest rules
- Get relevant rules — finds rules related to a given topic or keyword
- Get violations from a report — parses and filters a Jtest XML report (
report.xml) to retrieve violations
The server uses the current working directory as the workspace root and stores its local cache in .jtest/jtestmcp/ within that directory.
Integrating with GitHub Copilot
Create or update the .copilot/mcp-config.json file in your user home with the following content:
Windows
{
"mcpServers": {
"jtestmcp": {
"type": "local",
"command": "<INSTALL_DIR>\\integration\\mcp\\jtestmcp.bat",
"tools": [
"*"
],
"args": []
}
}
}
Linux / macOS
{
"mcpServers": {
"jtestmcp": {
"type": "local",
"command": "<INSTALL_DIR>/integration/mcp/jtestmcp",
"tools": [
"*"
],
"args": []
}
}
}
Replace the
commandpath with the actual path to your Jtest installation.- The
"tools": ["*"]entry enables all tools provided by the MCP server.- User level:
~/.copilot/mcp-config.json— applies globally to all projects.
- User level:
Integrating with Codex CLI
Create or update the .codex/config.toml file in your home directory or project root with the following content:
Windows
[mcp_servers.jtestmcp] command = "<INSTALL_DIR>\\integration\\mcp\\jtestmcp.bat"
Linux / macOS
[mcp_servers.jtestmcp] command = "<INSTALL_DIR>/integration/mcp/jtestmcp"
- The configuration file is typically located at
~/.codex/config.toml. - Codex CLI will automatically start the MCP server process when needed and communicate with it over stdio.
MCP Server Configuration
The MCP server reads its settings from <INSTALL_DIR>/integration/mcp/etc/jtestmcp.properties. The default configuration is:
documentation.path=${jtestmcp:root_dir}/jtest-ai-docs.zip
rule.documentation.path=${jtestmcp:root_dir}/jtest-ai-rules.zip
rule.doc.html.location=${jtestmcp:root_dir}/../../rules/doc.zip
product.name=Jtest
These paths are resolved relative to the MCP server root directory and generally do not need to be changed.
Local Storage
The MCP server stores its runtime cache in the following location:
- Default:
<workspace>/.jtest/jtestmcp/ - Fallback (if write access is unavailable):
%TEMP%\jtest\jtestmcp\(Windows) or$TMPDIR/jtest/jtestmcp/(Linux/macOS)
The workspace directory is automatically set to the current working directory from which the coding agent launches the MCP server process.
Troubleshooting
| Issue | Resolution |
|---|---|
| Server fails to start | Verify the path in command points to the correct Jtest installation. |
java not found | The launcher uses |
| No tools visible in agent | Confirm the MCP server process started without errors. Check the logs in
|
| Violations not returned | Ensure the report.xml path passed to the tool is accessible from the workspace directory. |
| Cache issues | Delete the |