Quarkus Model Context Protocol (MCP) Server
About
This extension enables developers to implement the MCP server features easily.
Details
- Author
- quarkiverse
- GitHub stars
- 193
- Downloads
- 349
- Categories
- Other
Jump to
- Declarative and programmatic APIs for MCP server implementation.
- Supports tools, prompts, and resources via CDI beans.
- Provides HTTP/SSE and STDIO transport options.
- Annotation-driven development with @Tool, @Prompt, @Resource.
- Integrates seamlessly with Quarkus build and runtime.
Add the quarkus-mcp-server-http (or quarkus-mcp-server-stdio) Maven dependency to your project. Annotate CDI bean methods with @Tool, @Prompt, or @Resource to define server features. Run your Quarkus application to start the MCP server.
Quarkus MCP Server
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<!-- ALL-CONTRIBUTORS-BADGE:END -->
This Quarkus extension provides both declarative and programmatic APIs that enable developers to easily implement MCP[^1] server features.
[^1]: _"Model Context Protocol (MCP) is an open protocol that enables seamless integration between LLM applications and external data sources and tools."_
> [!NOTE]
> The LangChain4j project provides the MCP client functionality, either as a low-level programmatic API or as a full-fledged integration into AI-infused applications.
Get Started
Step #1
Add the following dependency to your POM file:
<dependency>
<groupId>io.quarkiverse.mcp</groupId>
<artifactId>quarkus-mcp-server-http</artifactId>
<version>${quarkus-mcp-server-version}</version>
</dependency>
> [!NOTE]
> This dependency includes both the legacy "HTTP/SSE" and the "Streamable HTTP" transport. Use the quarkus-mcp-server-stdio artifactId if you want to use the STDIO transport instead. See also the Transports section in the docs for more information.
Step #2
Add server features (prompts, resources and tools) represented by _annotated business methods_ of CDI beans.
import jakarta.inject.Inject;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import io.quarkiverse.mcp.server.BlobResourceContents;
import io.quarkiverse.mcp.server.Prompt;
import io.quarkiverse.mcp.server.PromptArg;
import io.quarkiverse.mcp.server.PromptMessage;
import io.quarkiverse.mcp.server.Resource;
import io.quarkiverse.mcp.server.TextContent;
import io.quarkiverse.mcp.server.Tool;
// This class is automatically registered as a @Singleton CDI bean
public class MyFeatures {
@Inject
CodeService codeService;
@Tool(description = "Converts the string value to lower case")
String toLowerCase(String value) {
return value.toLowerCase();
}
@Prompt(name = "code_assist")
PromptMessage codeAssist(@PromptArg(name = "lang") String language) {
return PromptMessage.withUserRole(new TextContent(codeService.assist(language)));
}
@Resource(uri = "file:///project/alpha.txt")
byte[] alpha() throws IOException{
return Files.readAllBytes(Path.of("alpha.txt"));
}
}
Step #3
Run your Quarkus app and have fun!
Documentation
The full documentation is available at https://quarkiverse.github.io/quarkiverse-docs/quarkus-mcp-server/dev/index.html.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/mkouba">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/geoand">
<td align="center" valign="top" width="14.28%"><a href="https://xam.dk">
<td align="center" valign="top" width="14.28%"><a href="https://twitter.com/r_svoboda">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/gastaldi">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jmartisk">
<td align="center" valign="top" width="14.28%"><a href="http://iocanel.com">
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sberyozkin">
<td align="center" valign="top" width="14.28%"><a href="http://kpavlov.me">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/mvduijnhoven">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/PierreBtz">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/mrecouly">
<td align="center" valign="top" width="14.28%"><a href="https://wjglerum.nl">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/SaSteffen">
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/cescoffier">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rolfedh">
<td align="center" valign="top" width="14.28%"><a href="http://brunobat.com/about">
<td align="center" valign="top" width="14.28%"><a href="https://github.com/moayad-alyaghshi">
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the all-contributors specification. Contributions of any kind welcome!
Sign in to leave a review
Use Google, GitHub, or an email account so ratings stay tied to real people.
No reviews posted yet.
