Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions docs/src/main/asciidoc/dev-mcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,41 @@ This feature is currently experimental.
When you run a Quarkus application in dev mode, you can expose a Model Context Protocol (MCP) server.
It presents the methods used by the DevUI *MCP tools* (methods you can call) and the data exposed by *MCP resources*.

=== Connecting an MCP client
=== Connecting a coding agent

Open the **Dev UI** settings dialog and select the Dev MCP tab.
There you can enable Dev MCP, get the connection details (Default `http://localhost:8080/q/dev-mcp`) and see what clients are connected.
The recommended way to connect an AI coding agent to your Quarkus application is the https://github.com/quarkusio/quarkus-agent-mcp[Quarkus Agent MCP] server.
It manages the application lifecycle, proxies Dev MCP tools, provides documentation search, and delivers extension-specific coding skills.

Any MCP client that supports the https://modelcontextprotocol.io/specification/2025-03-26[Streamable Protocol, version 2025‑03‑26] can connect using that URL.
After a client connects, it will appears on the tab:
The Quarkus Agent MCP server requires https://www.jbang.dev[JBang].
Make sure JBang is installed before configuring your agent:

[source,bash]
----
jbang version
----

If JBang is not installed, you can install it with `curl -Ls https://sh.jbang.dev | bash` or `sdk install jbang`.

Most coding agents use stdio transport — for example, with https://claude.ai/claude-code[Claude Code]:

[source,bash]
----
claude mcp add quarkus-agent -- jbang quarkus-agent-mcp@quarkusio
----

Open the **Dev UI** settings dialog and select the Dev MCP tab to see configuration snippets for all supported agents and IDEs (Claude Code, Cursor, VS Code, Claude Desktop, Cline, Goose, Windsurf, Zed, and JetBrains IDEs).

image::dev_mcp_settings.png[Dev MCP Settings]

=== Connect an MCP client

Alternatively to connecting through the Quarkus Agent, you can connect an MCP client directly to the Dev MCP endpoint on the running application.
Open the **Dev UI** settings dialog, select the Dev MCP tab, and enable Dev MCP.
The connection details (default `http://localhost:8080/q/dev-mcp`) and per-agent configuration snippets are available under the **Direct connection** section.

Any MCP client that supports the https://modelcontextprotocol.io/specification/2025-03-26[Streamable Protocol, version 2025‑03‑26] can connect using that URL.
After a client connects, it will appear on the tab.

== Guide for extension developers

Extensions can contribute additional tools and resources to the Dev MCP server. The integration is similar to contributing to the xref:dev-ui.adoc[Dev UI], but descriptions are mandatory.
Expand Down
Binary file modified docs/src/main/asciidoc/images/dev_mcp_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading