Skip to content

Commit b4cfe8c

Browse files
authored
chore(docs): Update README.adoc
1 parent 4c845c9 commit b4cfe8c

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.adoc

+12-7
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Just put this one line code in your `main` method:
1010

1111
[source,java]
1212
----
13-
// You can specify the base package to scan for MCP resources, prompts, tools, but it's optional.
13+
// You can use this annotation to specify the base package
14+
// to scan for MCP resources, prompts, tools, but it's not required.
1415
@McpComponentScan(basePackage = "com.github.codeboyzhou.mcp.examples")
1516
public class MyMcpServer {
1617
@@ -24,7 +25,7 @@ public class MyMcpServer {
2425
}
2526
----
2627

27-
and don't need to care how to create the MCP resources, prompts, and tools. You only need to annotate them like this:
28+
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:
2829

2930
[source,java]
3031
----
@@ -34,7 +35,7 @@ public class MyMcpResources {
3435
// This method defines a MCP resource to expose the OS env variables
3536
@McpResource(uri = "env://variables", name = "env", description = "OS env variables")
3637
public String getSystemEnv() {
37-
// Only need to put your logic code here, forget about the MCP SDK details.
38+
// Just put your logic code here, forget about the MCP SDK details.
3839
return System.getenv().toString();
3940
}
4041
@@ -51,22 +52,26 @@ public class MyMcpTools {
5152
@McpTool(name = "read_file", description = "Read complete file contents with UTF-8 encoding")
5253
public String readFile(
5354
@McpToolParam(name = "path", description = "filepath", required = true) String path) {
54-
// Only need to put your logic code here, forget about the MCP SDK details.
55+
// Just put your logic code here, forget about the MCP SDK details.
5556
return Files.readString(Path.of(path));
5657
}
5758
5859
// Your other MCP tools here...
5960
}
6061
----
6162

62-
Now it's all set, choose one MCP client you like and start your MCP exploration journey.
63+
Now it's all set, run your MCP server, choose one MCP client you like and start your MCP exploration journey.
6364

6465
[WARNING]
6566

6667
Please note that this project is under development and is not ready for production use.
6768

6869
== Getting Started
6970

71+
=== Requirements
72+
73+
- Java 17 or later (Restricted by MCP Java SDK)
74+
7075
=== Installation
7176

7277
Add the following Maven dependency to your project:
@@ -80,9 +85,9 @@ Add the following Maven dependency to your project:
8085
</dependency>
8186
----
8287

83-
== Requirements
88+
=== Examples
8489

85-
- Java 17 or later (Restricted by MCP Java SDK)
90+
You can find more examples and usages in this https://github.com/codeboyzhou/mcp-declarative-java-sdk-examples[repository].
8691

8792
== What is MCP?
8893

0 commit comments

Comments
 (0)