Skip to content

Commit ddf6995

Browse files
committed
refactor(docs): Update README and getting-started documentation for MCP resources, prompts, and tools
1 parent 6212c19 commit ddf6995

File tree

2 files changed

+6
-15
lines changed

2 files changed

+6
-15
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,7 @@ streamable:
8383
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:
8484
8585
```java
86-
@McpResources
87-
public class MyMcpResources {
86+
public class McpResources {
8887

8988
// This method defines a MCP resource to expose the OS env variables
9089
@McpResource(uri = "env://variables", description = "OS env variables")
@@ -98,8 +97,7 @@ public class MyMcpResources {
9897
```
9998

10099
```java
101-
@McpPrompts
102-
public class MyMcpPrompts {
100+
public class McpPrompts {
103101

104102
// This method defines a MCP prompt to read a file
105103
@McpPrompt(description = "A simple prompt to read a file")
@@ -112,8 +110,7 @@ public class MyMcpPrompts {
112110
```
113111

114112
```java
115-
@McpTools
116-
public class MyMcpTools {
113+
public class McpTools {
117114

118115
// This method defines a MCP tool to read a file
119116
@McpTool(description = "Read complete file contents with UTF-8 encoding")

docs/docs/getting-started.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,8 @@ details of native MCP Java SDK.
202202

203203
```java
204204
import com.github.codeboyzhou.mcp.declarative.annotation.McpResource;
205-
import com.github.codeboyzhou.mcp.declarative.annotation.McpResources;
206205

207-
@McpResources
208-
public class MyMcpResources {
206+
public class McpResources {
209207

210208
/**
211209
* This method defines a MCP resource to expose the OS env variables.
@@ -225,10 +223,8 @@ public class MyMcpResources {
225223
```java
226224
import com.github.codeboyzhou.mcp.declarative.annotation.McpPrompt;
227225
import com.github.codeboyzhou.mcp.declarative.annotation.McpPromptParam;
228-
import com.github.codeboyzhou.mcp.declarative.annotation.McpPrompts;
229226

230-
@McpPrompts
231-
public class MyMcpPrompts {
227+
public class McpPrompts {
232228

233229
/**
234230
* This method defines a MCP prompt to read a file.
@@ -248,10 +244,8 @@ public class MyMcpPrompts {
248244
```java
249245
import com.github.codeboyzhou.mcp.declarative.annotation.McpTool;
250246
import com.github.codeboyzhou.mcp.declarative.annotation.McpToolParam;
251-
import com.github.codeboyzhou.mcp.declarative.annotation.McpTools;
252247

253-
@McpTools
254-
public class MyMcpTools {
248+
public class McpTools {
255249

256250
/**
257251
* This method defines a MCP tool to read a file.

0 commit comments

Comments
 (0)