Quarkus Mcp Server

Quarkus Model Context Protocol (MCP) Server

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-BADGE:END -->

“Model Context Protocol (MCP) is an open protocol that enables seamless integration between LLM applications and external data sources and tools.”

This extension provides declarative and programmatic APIs that enable developers to implement the MCP server features easily.

Get Started

Step #1

Add the following dependency to your POM file:

<dependency>
    <groupId>io.quarkiverse.mcp</groupId>
    <!-- use 'quarkus-mcp-server-stdio' if you want to use the STDIO transport instead of the HTTP/SSE transport -->
    <artifactId>quarkus-mcp-server-sse</artifactId>
    <version>${project-version}</version>
</dependency>

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.Tool;
import io.quarkiverse.mcp.server.Resource;
import io.quarkiverse.mcp.server.TextContent;

// This class is automatically registered as a @Singleton CDI bean
public class ServerFeatures {

    @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")
    BlobResourceContents alpha(RequestUri uri) throws IOException{
        return BlobResourceContents.create(uri.value(), Files.readAllBytes(Paths.ALPHA));
    }

}

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”><img src=“https://avatars.githubusercontent.com/u/913004?v=4?s=100” width=“100px;” alt=“Martin Kouba”/><br />_{<b>Martin Kouba</b>}</a><br /><a href=“https://github.com/quarkiverse/quarkus-mcp-server/commits?author=mkouba” title=“Code”>💻</a> <a href=“#maintenance-mkouba” title=“Maintenance”>🚧</a></td> <td align=“center” valign=“top” width=“14.28%”><a href=“https://github.com/geoand”><img src=“https://avatars.githubusercontent.com/u/4374975?v=4?s=100” width=“100px;” alt=“Georgios Andrianakis”/><br />_{<b>Georgios Andrianakis</b>}</a><br /><a href=“https://github.com/quarkiverse/quarkus-mcp-server/commits?author=geoand” title=“Code”>💻</a></td> <td align=“center” valign=“top” width=“14.28%”><a href=“https://xam.dk”><img src=“https://avatars.githubusercontent.com/u/54129?v=4?s=100” width=“100px;” alt=“Max Rydahl Andersen”/><br />_{<b>Max Rydahl Andersen</b>}</a><br /><a href=“#example-maxandersen” title=“Examples”>💡</a></td> <td align=“center” valign=“top” width=“14.28%”><a href=“https://twitter.com/r_svoboda”><img src=“https://avatars.githubusercontent.com/u/925259?v=4?s=100” width=“100px;” alt=“Rostislav Svoboda”/><br />_{<b>Rostislav Svoboda</b>}</a><br /><a href=“https://github.com/quarkiverse/quarkus-mcp-server/commits?author=rsvoboda” title=“Code”>💻</a></td> <td align=“center” valign=“top” width=“14.28%”><a href=“https://github.com/gastaldi”><img src=“https://avatars.githubusercontent.com/u/54133?v=4?s=100” width=“100px;” alt=“George Gastaldi”/><br />_{<b>George Gastaldi</b>}</a><br /><a href=“#infra-gastaldi” title=“Infrastructure (Hosting, Build-Tools, etc)”>🚇</a></td> </tr> </tbody> </table>

<!-- markdownlint-restore --> <!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!