A standalone MCP server that enables AI coding agents to create, manage, and interact with Quarkus applications. It runs as a separate process that survives app crashes, giving agents the ability to create projects, check for updates, read extension skills, control application lifecycle, proxy Dev MCP tools, and search Quarkus documentation.
Part of the DevStar working group.
- Java 21+
- Docker or Podman (for documentation search)
- One of: Quarkus CLI, Maven, or JBang (for creating new projects)
Add the marketplace and install the plugin:
claude plugin marketplace add quarkusio/quarkus-agent-mcp
claude plugin install quarkus-agent@quarkus-toolsThis installs the plugin and configures the MCP server automatically. Requires JBang.
JBang resolves the uber-jar from Maven Central automatically — no build step needed.
claude mcp add quarkus-agent -- jbang quarkus-agent-mcp@quarkusioAdd to .vscode/mcp.json in your workspace:
{
"servers": {
"quarkus-agent": {
"type": "stdio",
"command": "jbang",
"args": ["quarkus-agent-mcp@quarkusio"]
}
}
}Add to .bob/mcp.json:
{
"mcpServers": {
"quarkus-agent": {
"command": "jbang",
"args": ["quarkus-agent-mcp@quarkusio"]
}
}
}Add to .cursor/mcp.json:
{
"mcpServers": {
"quarkus-agent": {
"command": "jbang",
"args": ["quarkus-agent-mcp@quarkusio"]
}
}
}Add to ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"quarkus-agent": {
"command": "jbang",
"args": ["quarkus-agent-mcp@quarkusio"]
}
}
}In Settings → Tools → AI Assistant → MCP Servers (or the GitHub Copilot MCP settings), add a server with an absolute path to jbang:
{
"mcpServers": {
"quarkus-agent": {
"type": "stdio",
"command": "/home/you/.jbang/bin/jbang",
"args": ["quarkus-agent-mcp@quarkusio"]
}
}
}Why absolute paths? JetBrains IDEs launched from the desktop inherit the system PATH, not your shell PATH (
~/.bashrc/~/.zshrc). Tools installed via SDKMAN!, JBang's default installer, asdf, or mise are typically on the shell PATH only — so the IDE can't find them. See Troubleshooting below.
Alternatively, use the direct download method with an absolute path to java:
{
"mcpServers": {
"quarkus-agent": {
"type": "stdio",
"command": "/path/to/java",
"args": ["-jar", "/path/to/quarkus-agent-mcp-runner.jar"]
}
}
}Download the uber-jar from the latest GitHub Release, then:
claude mcp add quarkus-agent -- java -jar /path/to/quarkus-agent-mcp-runner.jargit clone https://github.com/quarkusio/quarkus-agent-mcp.git
cd quarkus-agent-mcp
./mvnw package -DskipTests -Dquarkus.package.jar.type=uber-jarThis produces the uber-jar at target/quarkus-agent-mcp-1.0.0-SNAPSHOT-runner.jar (version may vary).
claude mcp add quarkus-agent -- java -jar /path/to/quarkus-agent-mcp/target/quarkus-agent-mcp-1.0.11-runner.jarAfter registering, ask your agent something like:
"Search the Quarkus docs for how to create a REST endpoint"
If the MCP server is working, the agent will use quarkus_searchDocs and return documentation results.
Ask your agent to build a Quarkus application using natural language. The agent uses the MCP tools automatically.
Example conversation:
You: Create a Quarkus REST API with a greeting endpoint and a PostgreSQL database
Agent: (uses
quarkus_createto scaffold the project withrest-jackson,jdbc-postgresql,hibernate-orm-panacheextensions — the app starts automatically in dev mode, aCLAUDE.mdis generated with project-specific workflow instructions, and a.mcp.jsonis created for automatic MCP server discovery)Agent: (calls
quarkus_skillsto learn the correct patterns for Panache, REST, and other extensions before writing any code)You: Add a
Greetingentity and a REST endpoint that stores and retrieves greetingsAgent: (writes the code following patterns from skills, then runs tests using
quarkus_callTool— via a subagent if supported)
The MCP server guides the agent through the optimal Quarkus development workflow:
NEW PROJECT EXISTING PROJECT
1. quarkus_create 1. quarkus_update
→ scaffolds + auto-starts → checks version, suggests upgrades
→ generates CLAUDE.md + .mcp.json
2. quarkus_start
2. quarkus_skills → starts dev mode
→ learn extension patterns
3. quarkus_skills
3. quarkus_searchDocs → learn extension patterns
→ look up APIs, config
4. quarkus_searchDocs
4. Write code + tests → look up APIs, config
5. Run tests 5. Write code + tests
→ quarkus_callTool
→ devui-testing_runTests 6. Run tests
→ quarkus_callTool
6. Iterate → devui-testing_runTests
Key points:
- Hot reload is automatic in Quarkus dev mode — triggered on the next access (HTTP request or test run), not on file save.
- Skills before code — the agent reads extension-specific skills to learn correct patterns, testing approaches, and common pitfalls before writing any code.
- Tests via subagents — if your agent supports subagents, test execution can be dispatched to one so the main conversation stays responsive.
- The MCP server survives crashes — if the app crashes due to a code error, the agent can use
devui-exceptions_getLastExceptionto get structured exception details (class, message, stack trace, user code location) and fix it. Usequarkus_logsfor broader context. - CLAUDE.md — every new project gets a
CLAUDE.mdwith Quarkus-specific workflow instructions that guide the agent. .mcp.json— every new project gets a.mcp.jsonfor automatic MCP server discovery by agents that support the convention (Claude Code, Pi/pi.dev).
Once a Quarkus app is running in dev mode, the agent can discover and use all Dev MCP tools via quarkus_searchTools and quarkus_callTool. The tool list is dynamic — it changes when extensions are added or removed, so the agent should re-discover tools after any extension change. Typical tools include:
| Capability | How to discover | Example |
|---|---|---|
| Testing | quarkus_searchTools query: test |
Run all tests, run a specific test class |
| Configuration | quarkus_searchTools query: config |
View and change config properties |
| Extensions | quarkus_searchTools query: extension |
Add or remove extensions at runtime |
| Endpoints | quarkus_searchTools query: endpoint |
List all REST endpoints and their URLs |
| Dev Services | quarkus_searchTools query: dev-services |
View database URLs, container info |
| Log levels | quarkus_searchTools query: log |
Change log levels at runtime |
| Exceptions | devui-exceptions_getLastException |
Get last compilation/deployment/runtime exception with stack trace and source location |
The agent can read extension-specific coding skills using quarkus_skills. Skills contain patterns, testing guidelines, and common pitfalls for each extension — things like "always use @Transactional for write operations with Panache" or "don't create REST clients manually, let CDI inject them."
When called without a query, skills are organized by category (Web, Data, Security, Core, etc.) for easier discovery.
Skills are loaded using a three-layer chain (most specific wins):
- Extension skills — discovered from individual extension deployment JARs (
META-INF/quarkus-skill.md) in the local Maven repository, composed with extension metadata and available Dev MCP tools. This supports skills from Quarkus core, Quarkiverse, and custom extensions. For older Quarkus versions that don't ship skill files in deployment JARs, the aggregatedquarkus-extension-skillsJAR is used as a fallback. - User-level skills — from
~/.quarkus/skills/<extension-name>/SKILL.md(or a directory configured viaagent-mcp.local-skills-dir). Useful for extension developers testing new or modified skills without rebuilding the aggregated JAR. - Project-level skills — from
.agent/skills/<extension-name>/SKILL.mdin the project directory. These are standalone files read as-is (no composition with base layers), so any agent can read them directly from the filesystem. Usequarkus_saveSkillto materialize a fully composed skill into this directory, then edit the file directly.
Layers 1 and 2 support enhance and override composition, controlled by the mode field in the SKILL.md frontmatter:
mode: enhance(default) — appends content to the base skill. The base content is preserved and the customization is added after a separator. This is ideal for adding personal conventions or standards without losing the built-in guidance.mode: override— fully replaces the base skill. Use this when you need complete control over a skill's content.
Layer 3 (project) always replaces — the file content is used directly with no composition.
The agent can create or update global skill customizations using quarkus_updateSkill (writes to ~/.quarkus/skills/). For project-level customization, use quarkus_saveSkill to materialize the full composed skill into .agent/skills/, then edit the file directly.
The agent can search Quarkus documentation at any time using quarkus_searchDocs. This uses semantic search (BGE embeddings + pgvector) over the full Quarkus documentation.
On first use, a Docker/Podman container with the pre-indexed documentation is started automatically. If a project directory is provided, the documentation version matches the project's Quarkus version.
For existing projects, quarkus_update checks if the Quarkus version is current and provides a full upgrade report:
- Compares build files against reference projects
- Runs
quarkus update --dry-run(if CLI available) to preview automated migrations - Supports custom OpenRewrite recipes via
additionalUpdateRecipes(e.g.org.acme:my-recipes:1.0.0), either per-call or configured globally withagent-mcp.update.additional-recipes - Links to the structural diff between versions
- Recommends manual actions for changes that automated migration doesn't cover
| Tool | Description | Parameters |
|---|---|---|
quarkus_create |
Create a new Quarkus app, auto-start in dev mode, generate CLAUDE.md and .mcp.json |
outputDir (required), groupId, artifactId, extensions, buildTool, quarkusVersion, noCode, noWrapper, createInCurrentDir |
| Tool | Description | Parameters |
|---|---|---|
quarkus_update |
Check if project is up-to-date, provide upgrade report | projectDir (required), additionalUpdateRecipes |
| Tool | Description | Parameters |
|---|---|---|
quarkus_skills |
Get coding patterns, testing guidelines, and pitfalls for project extensions | projectDir (required), query |
quarkus_updateSkill |
Create or update a global skill customization (enhance or override) in ~/.quarkus/skills/ |
projectDir (required), skillName (required), content (required), description, categories, mode |
quarkus_saveSkill |
Materialize a composed skill as a standalone file in .agent/skills/ for any agent to read |
projectDir (required), skillName (required) |
| Tool | Description | Parameters |
|---|---|---|
quarkus_start |
Start a Quarkus app in dev mode | projectDir (required), buildTool |
quarkus_stop |
Graceful shutdown | projectDir (required) |
quarkus_restart |
Force restart (usually not needed — hot reload is automatic) | projectDir (required) |
quarkus_status |
Get app state | projectDir (required) |
quarkus_logs |
Get recent log output | projectDir (required), lines |
quarkus_list |
List all managed instances | (none) |
| Tool | Description | Parameters |
|---|---|---|
quarkus_searchTools |
Discover tools on the running app's Dev MCP server | projectDir (required), query |
quarkus_callTool |
Invoke a Dev MCP tool by name | projectDir (required), toolName (required), toolArguments |
| Tool | Description | Parameters |
|---|---|---|
quarkus_searchDocs |
Semantic search over Quarkus documentation | query (required), maxResults, projectDir |
In stdio mode, server logs are invisible because stdout/stderr are consumed by the MCP protocol.
File logging can be enabled permanently by setting agent-mcp.log.enabled=true. The easiest way is via an environment variable in your MCP server configuration:
Claude Code:
claude mcp add quarkus-agent -e AGENT_MCP_LOG_ENABLED=true -- jbang quarkus-agent-mcp@quarkusioVS Code / GitHub Copilot:
{
"servers": {
"quarkus-agent": {
"type": "stdio",
"command": "jbang",
"args": ["quarkus-agent-mcp@quarkusio"],
"env": {
"AGENT_MCP_LOG_ENABLED": "true"
}
}
}
}Cursor / Windsurf / JetBrains (JSON config):
{
"mcpServers": {
"quarkus-agent": {
"command": "jbang",
"args": ["quarkus-agent-mcp@quarkusio"],
"env": {
"AGENT_MCP_LOG_ENABLED": "true"
}
}
}
}Logs are written to ~/.quarkus/agent-mcp/agent-mcp.log.
The agent can also toggle file logging on-the-fly using these tools:
| Tool | Description | Parameters |
|---|---|---|
quarkus_agent_log_enable |
Enable file logging to ~/.quarkus/agent-mcp/agent-mcp.log |
(none) |
quarkus_agent_log_disable |
Disable file logging (the log file is preserved) | (none) |
quarkus_agent_log |
Read the last N lines from the log file | lines |
The MCP server wraps quarkus dev as a child process, so it stays alive when the app crashes. This is the key differentiator from the built-in Dev MCP server.
Configuration via application.properties, system properties (-D), or environment variables:
| Property | Default | Description |
|---|---|---|
agent-mcp.doc-search.image-prefix |
ghcr.io/quarkusio/chappie-ingestion-quarkus |
Docker image prefix for pre-indexed docs |
agent-mcp.doc-search.image-tag |
latest |
Default image tag (overridden by detected Quarkus version) |
agent-mcp.doc-search.pg-user |
quarkus |
PostgreSQL user |
agent-mcp.doc-search.pg-password |
quarkus |
PostgreSQL password |
agent-mcp.doc-search.pg-database |
quarkus |
PostgreSQL database |
agent-mcp.doc-search.min-score |
0.82 |
Minimum similarity score for search results |
agent-mcp.local-skills-dir |
~/.quarkus/skills |
Directory for user-level skill customizations |
agent-mcp.process.mvn-cmd |
(auto-detect) | Override the Maven command used to start dev mode (e.g. mvn to skip wrapper detection) |
agent-mcp.process.gradle-cmd |
(auto-detect) | Override the Gradle command used to start dev mode (e.g. gradle to skip wrapper detection) |
agent-mcp.log.enabled |
false |
Enable file logging on startup — logs are written to ~/.quarkus/agent-mcp/agent-mcp.log |
agent-mcp.update.additional-recipes |
(none) | Additional OpenRewrite recipe artifacts for quarkus_update (e.g. org.acme:my-recipes:1.0.0) |
For instant startup (no JVM warmup):
./mvnw package -Dnative -DskipTests -Dquarkus.package.jar.type=uber-jarThen reference the native binary in your MCP config:
claude mcp add quarkus-agent -- ./target/quarkus-agent-mcp-*-runnerAn HTML slide deck is available in the presentation/ directory for team demos and talks.
# Open directly in a browser
xdg-open presentation/index.html # Linux
open presentation/index.html # macOSPress F for fullscreen, arrow keys or space to navigate slides.
Error: spawn jbang ENOENT
This happens when the MCP client (IDE, desktop app) cannot find jbang or java on its PATH. It affects JetBrains IDEs, Claude Desktop, and other desktop applications that don't inherit your shell environment.
Why it happens: Desktop applications launched from a graphical environment inherit the system PATH (from systemd on Linux, or system environment variables on Windows/macOS), not the shell PATH (from ~/.bashrc, ~/.zshrc, ~/.profile). Tools installed via user-local version managers — SDKMAN!, JBang's default installer, asdf, mise — are on the shell PATH but not the system PATH.
This is different from VS Code, which typically resolves the full shell environment, and from IDE built-in terminals, which start a proper login shell.
Solutions (pick one):
-
Use absolute paths in your MCP config (recommended):
{ "command": "/home/you/.jbang/bin/jbang", "args": ["quarkus-agent-mcp@quarkusio"] }Find the path with
which jbangorwhich javain a terminal. -
Symlink into a system PATH directory:
sudo ln -s ~/.jbang/bin/jbang /usr/local/bin/jbang -
Add to the system PATH permanently:
- Linux (systemd): Create
/etc/profile.d/jbang.shwithexport PATH="$HOME/.jbang/bin:$PATH", or add the path to~/.config/environment.d/for systemd user sessions. - macOS: Use
launchctl setenv PATH ...or add to/etc/paths.d/. - Windows: Add
%USERPROFILE%\.jbang\binto the system environment variables (System → Advanced → Environment Variables → System variables → Path).
- Linux (systemd): Create
java.nio.file.AccessDeniedException: C:\WINDOWS\system32\config
This is a Quarkus core issue that occurs on Windows when the MCP server is launched by an IDE with the working directory set to system32. Quarkus scans {working-dir}/config for configuration files and hits the protected Windows registry hive directory.
Workaround: Set the working directory explicitly in your MCP config, or pass -Duser.dir to override it:
{
"servers": {
"quarkus-agent": {
"type": "stdio",
"command": "java",
"args": ["-Duser.dir=C:\\Users\\you", "-jar", "C:\\path\\to\\quarkus-agent-mcp-runner.jar"]
}
}
}- Creating Extension Skills - A practical guide for extension developers to discover, write, and test AI skills for their extensions
- Quarkus Dev MCP — Built-in MCP server inside running Quarkus apps
- quarkus-skills — Standalone skill files for Quarkus (Agent Skills specification)
- code-with-quarkus-compare — Reference projects for build file comparison
- chappie-docling-rag — Builds the pgvector Docker images with pre-indexed Quarkus docs
- quarkus-mcp-server — Quarkiverse MCP Server extension used by this project
Quarkus Agent MCP runs entirely on your local machine. It does not collect, transmit, or store any personal data, telemetry, or analytics.
The server makes the following outbound network requests, all in service of its documented features:
| Request | Destination | Purpose |
|---|---|---|
| Skills JAR download | repo1.maven.org (or your configured Maven mirror) |
Download extension-specific coding patterns for your project's Quarkus version |
| Version check | github.com/quarkusio/code-with-quarkus-compare |
Determine the latest Quarkus version and fetch reference build files for update comparison |
| Documentation container | ghcr.io/quarkusio/chappie-ingestion-quarkus |
Pull a Docker image with pre-indexed Quarkus documentation for local semantic search |
| Dev MCP proxy | localhost only |
Communicate with your running Quarkus application's Dev MCP server |
No data is sent to Quarkus, Red Hat, or any third party. All downloaded artifacts are cached locally in standard locations (~/.m2/repository, Docker image cache). Source code and project files never leave your machine.
Apache License 2.0

