Skip to content

Commit

Permalink
Merge pull request #69 from mkouba/docs-minor
Browse files Browse the repository at this point in the history
Minor fixes/changes in docs and readme
  • Loading branch information
mkouba authored Jan 17, 2025
2 parents 2810fee + b0cbaa8 commit 1cd66ff
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Quarkus Model Context Protocol (MCP) Server
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

[![Version](https://img.shields.io/maven-central/v/io.quarkiverse.mcp/quarkus-mcp-server?logo=apache-maven&style=flat-square)](https://central.sonatype.com/artifact/io.quarkiverse.mcp/quarkus-mcp-server-parent)
[![Version](https://img.shields.io/maven-central/v/io.quarkiverse.mcp/quarkus-mcp-server-parent?logo=apache-maven&style=flat-square)](https://central.sonatype.com/artifact/io.quarkiverse.mcp/quarkus-mcp-server-parent)

_"[Model Context Protocol](https://modelcontextprotocol.io/) (MCP) is an open protocol that enables seamless integration between LLM applications and external data sources and tools."_

Expand Down Expand Up @@ -63,9 +63,11 @@ public class ServerFeatures {
}
```

Step #3 - run your Quarkus app!
Step #3 - run your Quarkus app and have fun!

Read the full [documentation](https://quarkiverse.github.io/quarkiverse-docs/quarkus-mcp-server/dev/index.html).
## Documentation

The full documentation is available at https://quarkiverse.github.io/quarkiverse-docs/quarkus-mcp-server/dev/index.html.

## Contributors ✨

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For instance, with Maven, add the following dependency to your POM file:
</dependency>
----

TIP: The SSE endpoint is exposed at `/{rootPath}/sse` and the `{rootPath}` is set to `mcp` by default. However, it can be changed with the `quarkus.mcp.server.sse.root-path` configuration property.
TIP: The SSE endpoint is exposed at `/{rootPath}/sse`. The `{rootPath}` is set to `mcp` by default but it can be changed with the `quarkus.mcp.server.sse.root-path` configuration property.

== Supported server features

Expand Down Expand Up @@ -229,7 +229,7 @@ public class MyResourceTemplates {
<2> `MyResourceTemplates` is an ordinary CDI bean. It can inject other beans, use interceptors, etc.
<3> `@ResourceTemplate` annotates a business method of a CDI bean that should be exposed as a resource template. By default, the name of the resource template is derived from the method name.
<4> `ResourceTemplate#uriTemplate()` contains a Level 1 URI template (https://datatracker.ietf.org/doc/html/rfc6570#section-1.2[RFC 6570]) that can be used to construct resource URIs.
<5> The `String uri` parameter refers to the actual resource URI.
<5> The `name` parameter refers to the expression from the URI template. The `uri` parameter refers to the actual resource URI.

The result of a "resource read" operation is always represented as a `ResourceResponse`.
However, the annotated method can also return other types that are converted according to the following rules.
Expand Down

0 comments on commit 1cd66ff

Please sign in to comment.