From d88f9c493137e9e9aa5d4578282e74d4b43834c6 Mon Sep 17 00:00:00 2001 From: Max Rydahl Andersen Date: Fri, 10 Jan 2025 14:33:55 +0100 Subject: [PATCH 1/2] document the jbang option --- samples/weather/README.md | 49 ++++++--------------------------------- 1 file changed, 7 insertions(+), 42 deletions(-) diff --git a/samples/weather/README.md b/samples/weather/README.md index 6a9b23e..aa2d2fd 100644 --- a/samples/weather/README.md +++ b/samples/weather/README.md @@ -1,58 +1,23 @@ -# weather +# Weather Model Context Protocol Server This project uses Quarkus, the Supersonic Subatomic Java Framework. If you want to learn more about Quarkus, please visit its website: . -## Running the application in dev mode - -You can run your application in dev mode that enables live coding using: - -```shell script -./mvnw compile quarkus:dev -``` - -> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at . - ## Packaging and running the application -The application can be packaged using: - -```shell script -./mvnw package -``` - -It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory. -Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory. - -The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`. - -If you want to build an _über-jar_, execute the following command: +The application can be packaged and installed using: ```shell script -./mvnw package -Dquarkus.package.jar.type=uber-jar +./mvnw install ``` -The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`. - -## Creating a native executable - -You can create a native executable using: - -```shell script -./mvnw package -Dnative -``` +This builds an uber jar and you can run it directly using `jbang org.acme:weather:1.0.0-SNAPSHOT:runner` -Or, if you don't have GraalVM installed, you can run the native executable build in a container using: +To use in a MCP host client, you can use the following command: ```shell script -./mvnw package -Dnative -Dquarkus.native.container-build=true +jbang --quiet org.acme:weather:1.0.0-SNAPSHOT:runner ``` -You can then execute your native executable with: `./target/weather-1.0.0-SNAPSHOT-runner` - -If you want to learn more about building native executables, please consult . - -## Related Guides - -- Qute ([guide](https://quarkus.io/guides/qute)): Offer templating support for web, email, etc in a build time, type-safe way +The `--quiet` flag is used to suppress any output of the jbang script. \ No newline at end of file From b1874d458a5938009d770c9e6bca2fe465c26d95 Mon Sep 17 00:00:00 2001 From: Max Rydahl Andersen Date: Fri, 10 Jan 2025 14:41:28 +0100 Subject: [PATCH 2/2] Update samples/weather/README.md Co-authored-by: Martin Kouba --- samples/weather/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/weather/README.md b/samples/weather/README.md index aa2d2fd..a76c57e 100644 --- a/samples/weather/README.md +++ b/samples/weather/README.md @@ -1,4 +1,4 @@ -# Weather Model Context Protocol Server +# Weather MCP Server This project uses Quarkus, the Supersonic Subatomic Java Framework.