Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

better readme for sample #49

Merged
merged 2 commits into from
Jan 12, 2025
Merged

better readme for sample #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d88f9c4
document the jbang option
maxandersen Jan 10, 2025
b1874d4
Update samples/weather/README.md
maxandersen Jan 10, 2025
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
49 changes: 7 additions & 42 deletions samples/weather/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,23 @@
# weather
# Weather MCP Server

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: <https://quarkus.io/>.

## 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 <http://localhost:8080/q/dev/>.

## 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 <https://quarkus.io/guides/maven-tooling>.

## 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.
Loading