Skip to content

Commit 4470a61

Browse files
committed
ref docs improvmentes
Signed-off-by: Christian Tzolov <[email protected]>
1 parent 50fec36 commit 4470a61

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/mcp/mcp-stateless-server-boot-starter-docs.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Stateless MCP servers are designed for simplified deployments where session state is not maintained between requests.
55
These servers are ideal for microservices architectures and cloud-native deployments.
66

7-
NOTE: They require xref:api/mcp/mcp-client-boot-starter-docs#_streamable_http_transport_properties[streamable-HTTP clients] to support the necessary protocols for handling these features.
7+
TIP: Use the xref:api/mcp/mcp-client-boot-starter-docs#_streamable_http_transport_properties[Streamable-HTTP clients] to connect to the stateless servers.
88

9-
NOTE: Stateless servers don't support message requests to the MCP client (e.g., elicitation, sampling, ping).
9+
NOTE: The stateless servers don't support message requests to the MCP client (e.g., elicitation, sampling, ping).
1010

1111
=== Stateless WebMVC Server
1212

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/mcp/mcp-stdio-sse-server-boot-starter-docs.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
The STDIO and SSE MCP Servers support multiple transport mechanisms, each with its dedicated starter.
55

6+
TIP: Use the xref:api/mcp/mcp-client-boot-starter-docs#_stdio_transport_properties[STDIO clients] or xref:api/mcp/mcp-client-boot-starter-docs#_sse_transport_properties[SSE clients] to connect to the STDIO and SSE servers.
7+
68
=== STDIO MCP Server
79

810
Full MCP Server feature support with `STDIO` server transport.
@@ -103,6 +105,8 @@ All SSE properties are prefixed with `spring.ai.mcp.server`:
103105
|`keep-alive-interval` |Connection keep-alive interval |`null` (disabled)
104106
|===
105107

108+
NOTE: For backward compatibility reasons, the SSE properties do not have additional suffix (like `.sse`).
109+
106110
== Features and Capabilities
107111

108112
The MCP Server Boot Starter allows servers to expose tools, resources, and prompts to clients.
@@ -356,12 +360,14 @@ spring:
356360
version: 1.0.0
357361
type: SYNC
358362
instructions: "This server provides weather information tools and resources"
359-
sse-message-endpoint: /mcp/messages
360363
capabilities:
361364
tool: true
362365
resource: true
363366
prompt: true
364367
completion: true
368+
# sse properties
369+
sse-message-endpoint: /mcp/messages
370+
keep-alive-interval: 30s
365371
----
366372

367373
=== WebFlux Server Configuration
@@ -376,12 +382,14 @@ spring:
376382
version: 1.0.0
377383
type: ASYNC # Recommended for reactive applications
378384
instructions: "This reactive server provides weather information tools and resources"
379-
sse-message-endpoint: /mcp/messages
380385
capabilities:
381386
tool: true
382387
resource: true
383388
prompt: true
384389
completion: true
390+
# sse properties
391+
sse-message-endpoint: /mcp/messages
392+
keep-alive-interval: 30s
385393
----
386394

387395
=== Creating a Spring Boot Application with MCP Server

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/mcp/mcp-streamable-http-server-boot-starter-docs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
link:https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http[Streamable-HTTP] MCP servers provide enhanced functionality with support for change notifications and persistent connections.
55
These servers, introduced with spec version link:https://modelcontextprotocol.io/specification/2025-03-26[2025-03-26], are ideal for applications that need to notify clients about dynamic changes to tools, resources, or prompts.
66

7-
NOTE: They require xref:api/mcp/mcp-client-boot-starter-docs#_streamable_http_transport_properties[streamable-HTTP clients] to support the necessary protocols for handling these features.
7+
TIP: Use the xref:api/mcp/mcp-client-boot-starter-docs#_streamable_http_transport_properties[Streamable-HTTP clients] to connect to the Streamable-HTTP servers.
88

99
=== Streamable-HTTP WebMVC Server
1010

0 commit comments

Comments
 (0)