Skip to content

Commit

Permalink
blog about mcp server
Browse files Browse the repository at this point in the history
  • Loading branch information
maxandersen committed Jan 13, 2025
1 parent 6dd0370 commit 1eaea46
Show file tree
Hide file tree
Showing 5 changed files with 283 additions and 0 deletions.
20 changes: 20 additions & 0 deletions _posts/2024-01-29-ngrok.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
layout: post
title: 'ngrok: Expose your local services to the Internet'
date: 2024-01-29
tags: development-tips
synopsis: 'ngrok is a tool that allows you to expose your local services and the Quarkus integration have some recent updates.'
author: maxandersen
---
:imagesdir: /assets/images/posts/ngrok

Imagine you are working on a Zulip chatbot or GitHub integration or some other Quarkus application that uses webhooks to call into your application. How do you test that locally?

You need to somehow expose your local service to the internet so that the webhook can be (pun intended) hooked in. There are various options out there like ultrahook, localtunnel, and ngrok.

In this post, we will look at ngrok and how you can use it with Quarkus.

https://ngrok.com[ngrok] is a local running agent that via a cloud service allows you to expose your local services to the internet.



263 changes: 263 additions & 0 deletions _posts/2025-01-13-mcp-server.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,263 @@
= Implementing a MCP server in Quarkus
:page-layout: post
:page-title: 'Implementing a MCP server in Quarkus'
:page-date: 2025-01-13
:page-tags: [langchain4j, llm, ai]
:page-synopsis: Shows how to implement an MCP server in Quarkus and use it in various clients
:page-author: maxandersen
:imagesdir: /assets/images/posts/mcp
ifdef::env-github,env-browser,env-vscode[:imagesdir: ../assets/images/posts/mcp]

The Model Context Protocol (MCP) is an emerging standard that enables AI models to safely interact with external tools and resources. In this tutorial, I'll show you how to implement an MCP server using Quarkus, allowing you to extend AI applications with custom tools powered by the Java ecosystem.

== What we'll be building

We'll implement a simple MCP server that provides tools to get weather forecasts and alerts for US-based locations. We've chosen this example because it aligns with the official MCP quickstart guide at https://modelcontextprotocol.io/quickstart/server[modelcontextprotocol.io/quickstart/server], making it easier to compare implementations across different languages.

Our server will expose two tools: `getAlerts` and `getForecast`. Once built, we'll connect it to an MCP host that runs the server as a subprocess. Here's how it looks when integrated with Claude:

image::claude-example.png[Claude MCP Integration Example]

== Core MCP Concepts

MCP servers can provide three main types of capabilities:

Resources:: File-like data that can be read by clients (like API responses or file contents)
Tools:: Functions that can be called by the LLM (with user approval)
Prompts:: Pre-written templates that help users accomplish specific tasks

This tutorial focuses on implementing tools.

=== Prerequisites

To follow this tutorial you need:

* Familiarity with Quarkus and Java
* Understanding of LLMs (OpenAI, Granite, Anthropic, Google, etc.)

=== System requirements

* Quarkus CLI
* JBang (optionally)

=== Set up your project

First, create a new Quarkus project with rest-client, qute and mcp server extension without default boilerplate code:

[source,bash]
----
quarkus create app --no-code -x rest-client-jackson,qute,mcp-server-stdio weather
----

[NOTE]
====
We're using the `stdio` variant as it's required for MCP hosts that run the server as a subprocess. While an `sse` variant exists for Server-Sent Events streaming, we'll focus on the standard input/output approach.
====

== Building the server

Create a new file `src/main/java/org/acme/Weather.java`. The complete code for this example is available here: [].

=== Weather API Integration

First, let's set up the REST client for the weather API:

[source,java]
----
@RegisterRestClient(baseUri = "https://api.weather.gov")
public interface WeatherClient {
// Get active alerts for a specific state
@GET
@Path("/alerts/active/area/{state}")
Alerts getAlerts(@RestPath String state);
// Get point metadata for coordinates
@GET
@Path("/points/{latitude},{longitude}")
JsonObject getPoints(@RestPath double latitude, @RestPath double longitude);
// Get detailed forecast using dynamically provided URL
@GET
@Path("/")
Forecast getForecast(@Url String url);
}
----

To handle the API responses, we'll define some data classes. Note that we're only including the fields we need, as the complete API response contains much more data:

[source,java]
----
static record Period(
String name,
int temperature,
String temperatureUnit,
String windSpeed,
String windDirection,
String detailedForecast) {
}
static record ForecastProperties(
List<Period> periods) {
}
static record Forecast(
ForecastProperties properties) {
}
----

Since the Weather API uses redirects, add this to your `application.properties`:

[source,properties]
----
quarkus.rest-client.follow-redirects=true
----

=== Formatting Helpers

We'll use Qute templates to format the weather data:

[source,java]
----
String formatForecast(Forecast forecast) {
return forecast.properties().periods().stream().map(period -> {
// Template for each forecast period
return Qute.fmt(
"""
Temperature: {p.temperature}°{p.temperatureUnit}
Wind: {p.windSpeed} {p.windDirection}
Forecast: {p.detailedForecast}
""",
Map.of("p", period)).toString();
}).collect(Collectors.joining("\n---\n"));
}
----

=== Implementing MCP Tools

Now let's implement the actual MCP tools. The `@Tool` annotation from `io.quarkiverse.mcp.server` marks methods as available tools, while `@ToolArg` describes the parameters:

[source,java]
----
@Tool(description = "Get weather alerts for a US state.")
String getAlerts(@ToolArg(description = "Two-letter US state code (e.g. CA, NY)") String state) {
return formatAlerts(weatherClient.getAlerts(state));
}
@Tool(description = "Get weather forecast for a location.")
String getForecast(
@ToolArg(description = "Latitude of the location") double latitude,
@ToolArg(description = "Longitude of the location") double longitude) {
// First get the point metadata which contains the forecast URL
var points = weatherClient.getPoints(latitude, longitude);
// Extract the forecast URL using Qute template
var url = Qute.fmt("{p.properties.forecast}", Map.of("p", points));
// Get and format the forecast
return formatForecast(weatherClient.getForecast(url));
}
----

[NOTE]
====
The forecast API requires a two-step process where we first get point metadata and then use a URL from that response to fetch the actual forecast.
====

== Running the Server

To simplify deployment and development, we'll package the server as an uber-jar and enable file logging (since stdio is reserved for the MCP protocol):

[source,properties]
----
quarkus.package.uber-jar=true
quarkus.log.file.enable=true
quarkus.log.file.path=weather-quarkus.log
----

After running `mvn install`, you can use JBang to run the server using its Maven coordinates: `org.acme:weather:1.0.0-SNAPSHOT:runner`
or manually using `java -jar target/weather-1.0.0-SNAPSHOT-runner.jar`.

=== Integration with Claude

Add this to your `claude_desktop_config.json`:

[source,json]
----
{
"mcpServers": {
"weather": {
"command": "jbang",
"args": ["--quiet",
"org.acme:weather:1.0.0-SNAPSHOT:runner"]
}
}
}
----

The `--quiet` flag prevents JBang's output from interfering with the MCP protocol.

image::claude-tools.png[Claude Tools Integration]

[NOTE]
====
You can also run the server directly withou using java - then it would be something like `java -jar <FULL PATH>/weather-1.0.0-SNAPSHOT-runner.jar`. We use JBang here because simpler if you want to share with someone who does not want to build the MCP server locally.
====

== Development Tools

=== MCP Inspector

For development and testing, you can use the MCP Inspector tool:

[source,bash]
----
npx @modelcontextprotocol/inspector
----

This starts a local web server where you can test your MCP server:

image::mcp-inspector.png[MCP Inspector Interface]

=== Integration with LangChain4j

Since version 0.23.0, Quarkus LangChain4j supports MCP. For detailed information, see https://quarkus.io/blog/quarkus-langchain4j-mcp/[Using the Model Context Protocol with Quarkus+LangChain4j].

To use our weather server with LangChain4j, add this configuration:

[source,properties]
----
quarkus.langchain4j.mcp.weather.transport-type=stdio
quarkus.langchain4j.mcp.weather.command=jbang,--quiet,org.acme:weather:1.0.0-SNAPSHOT:runner
----

== Other Clients/MCP Hosts

The Model Context Protocol has a page listing https://modelcontextprotocol.io/clients[known clients].

While I have not tested all the various clients and MCP hosts, the similar approach of using `jbang --quiet <GAV>` should work for most if not all of them.

== Testing the Server

You can test the server through Claude or other MCP hosts with queries like:

* "What is the weather forecast for Solvang?"
* "What are the weather alerts for New York?"

Here's what happens behind the scenes:

1. Your question goes to the LLM along with available tools information
2. The LLM analyzes the question and determines which tools to use
3. The client executes the selected tools via the MCP server
4. Results return to the LLM
5. The LLM formulates an answer using the tool results
6. You see the final response!

== Conclusion

We've seen how Quarkus makes implementing an MCP server straightforward, requiring minimal boilerplate code compared to other implementations. The combination of Quarkus's extension system and JBang makes development and deployment efficient.

=== Further Reading

* https://modelcontextprotocol.io[Model Context Protocol Documentation]
* https://docs.quarkiverse.io/quarkus-mcp-server/dev/[Quarkus MCP Extension Guide]
* https://weather.gov/api[Weather API Documentation]
* https://quarkus.io/blog/quarkus-langchain4j-mcp/[Using MCP with Quarkus+LangChain4j]
Binary file added assets/images/posts/mcp/claude-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/posts/mcp/claude-tools.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/posts/mcp/mcp-inspector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1eaea46

Please sign in to comment.