Skip to content

Commit 3b4165e

Browse files
committed
chore(docs): Update README.md
1 parent 4e5000b commit 3b4165e

File tree

1 file changed

+27
-31
lines changed

1 file changed

+27
-31
lines changed

README.adoc renamed to README.md

+27-31
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
= Annotation-driven MCP Java SDK
1+
# Annotation-driven MCP Java SDK
22

3-
image:https://img.shields.io/badge/Java-17+-blue[java-version]
4-
image:https://img.shields.io/maven-central/v/io.github.codeboyzhou/mcp-declarative-java-sdk?color=blue[maven-central-version]
5-
image:https://img.shields.io/codecov/c/github/codeboyzhou/mcp-declarative-java-sdk?color=brightgreen[codecov-coverage]
6-
image:https://img.shields.io/github/actions/workflow/status/codeboyzhou/mcp-declarative-java-sdk/maven-build.yml[github-action-status]
3+
![Java](https://img.shields.io/badge/Java-17+-blue)
4+
[![maven-central](https://img.shields.io/maven-central/v/io.github.codeboyzhou/mcp-declarative-java-sdk?color=blue)](https://mvnrepository.com/artifact/io.github.codeboyzhou/mcp-declarative-java-sdk)
5+
[![coverage](https://img.shields.io/codecov/c/github/codeboyzhou/mcp-declarative-java-sdk?logo=codecov&color=brightgreen)](https://app.codecov.io/github/codeboyzhou/mcp-declarative-java-sdk)
6+
[![GitHub Action](https://github.com/codeboyzhou/mcp-declarative-java-sdk/actions/workflows/maven-build.yml/badge.svg)](https://github.com/codeboyzhou/mcp-declarative-java-sdk/actions/workflows/maven-build.yml)
77

8-
Declarative https://github.com/modelcontextprotocol/java-sdk[MCP Java SDK] Development with Java Annotations.
8+
Declarative [MCP Java SDK](https://github.com/modelcontextprotocol/java-sdk) Development with Java Annotations.
9+
10+
## Advantages
911

10-
== Advantages
1112
- No Spring Framework Required.
1213
- Instant MCP Java server in 1 LOC.
1314
- No need to write more SDK low-level codes.
1415
- Get rid of complex and lengthy JSON schema definitions.
1516
- Just focus on your core logic (resources/prompts/tools).
1617

17-
== Showcase
18+
## Showcase
1819

1920
Just put this one line code in your `main` method:
2021

21-
[source,java]
22-
----
22+
```java
2323
// You can use this annotation to specify the base package
2424
// to scan for MCP resources, prompts, tools, but it's optional.
2525
@McpComponentScan(basePackage = "com.github.codeboyzhou.mcp.examples")
@@ -33,12 +33,11 @@ public class MyMcpServer {
3333
}
3434

3535
}
36-
----
36+
```
3737

3838
No need to care about the low-level details of native MCP Java SDK and how to create the MCP resources, prompts, and tools. Just annotate them like this:
3939

40-
[source,java]
41-
----
40+
```java
4241
@McpResources
4342
public class MyMcpResources {
4443

@@ -51,10 +50,9 @@ public class MyMcpResources {
5150

5251
// Your other MCP resources here...
5352
}
54-
----
53+
```
5554

56-
[source,java]
57-
----
55+
```java
5856
@McpTools
5957
public class MyMcpTools {
6058

@@ -68,45 +66,43 @@ public class MyMcpTools {
6866

6967
// Your other MCP tools here...
7068
}
71-
----
69+
```
7270

7371
Now it's all set, run your MCP server, choose one MCP client you like and start your MCP exploration journey.
7472

75-
[WARNING]
76-
77-
Please note that this project is under development and is not ready for production use.
73+
> [!WARNING]
74+
> Please note that this project is under development and is not ready for production use.
7875
79-
== Getting Started
76+
## Getting Started
8077

81-
=== Requirements
78+
### Requirements
8279

8380
- Java 17 or later (Restricted by MCP Java SDK)
8481

85-
=== Installation
82+
### Installation
8683

8784
Add the following Maven dependency to your project:
8885

89-
[source,xml]
90-
----
86+
```xml
9187
<!-- Internally relies on native MCP Java SDK 0.9.0 -->
9288
<dependency>
9389
<groupId>io.github.codeboyzhou</groupId>
9490
<artifactId>mcp-declarative-java-sdk</artifactId>
9591
<version>0.2.0</version>
9692
</dependency>
97-
----
93+
```
9894

99-
=== Examples
95+
### Examples
10096

101-
You can find more examples and usages in this https://github.com/codeboyzhou/mcp-declarative-java-sdk-examples[repository].
97+
You can find more examples and usages in this [repository](https://github.com/codeboyzhou/mcp-declarative-java-sdk-examples).
10298

103-
== What is MCP?
99+
## What is MCP?
104100

105-
The https://modelcontextprotocol.io[Model Context Protocol (MCP)] lets you build servers that expose data and functionality to LLM applications in a secure, standardized way. Think of it like a web API, but specifically designed for LLM interactions. MCP servers can:
101+
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io) lets you build servers that expose data and functionality to LLM applications in a secure, standardized way. Think of it like a web API, but specifically designed for LLM interactions. MCP servers can:
106102

107103
- Expose data through **Resources** (think of these sort of like GET endpoints; they are used to load information into the LLM's context)
108104
- Provide functionality through **Tools** (sort of like POST endpoints; they are used to execute code or otherwise produce a side effect)
109105
- Define interaction patterns through **Prompts** (reusable templates for LLM interactions)
110106
- And more!
111107

112-
You can start exploring everything about *MCP* from https://modelcontextprotocol.io[here].
108+
You can start exploring everything about **MCP** from [here](https://modelcontextprotocol.io).

0 commit comments

Comments
 (0)