Skip to content

Commit 50fec36

Browse files
committed
Update MCP reference docs
Signed-off-by: Christian Tzolov <[email protected]>
1 parent d3fec94 commit 50fec36

File tree

3 files changed

+59
-25
lines changed

3 files changed

+59
-25
lines changed

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

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ NOTE: Stateless servers don't support message requests to the MCP client (e.g.,
4040

4141
== Configuration Properties
4242

43-
All properties are prefixed with `spring.ai.mcp.server.stateless`:
43+
=== Common Properties
44+
45+
All Common properties are prefixed with `spring.ai.mcp.server`:
4446

4547
[options="header"]
4648
|===
@@ -56,11 +58,19 @@ All properties are prefixed with `spring.ai.mcp.server.stateless`:
5658
|`capabilities.prompt` |Enable/disable prompt capabilities |`true`
5759
|`capabilities.completion` |Enable/disable completion capabilities |`true`
5860
|`tool-response-mime-type` |Response MIME type per tool name |`-`
59-
|`mcp-endpoint` |Custom MCP endpoint path |`/mcp`
6061
|`request-timeout` |Request timeout duration |`20 seconds`
61-
|`disallow-delete` |Disallow delete operations |`false`
6262
|===
6363

64+
=== Stateless Connection Properties
65+
66+
All connection properties are prefixed with `spring.ai.mcp.server.streamable-http`:
67+
68+
[options="header"]
69+
|===
70+
|Property |Description |Default
71+
|`mcp-endpoint` |Custom MCP endpoint path |`/mcp`
72+
|`disallow-delete` |Disallow delete operations |`false`
73+
|===
6474

6575
== Features and Capabilities
6676

@@ -193,16 +203,15 @@ public List<McpStatelessServerFeatures.SyncCompletionSpecification> myCompletion
193203
=== Stateless Server Configuration
194204
[source,yaml]
195205
----
196-
# Using spring-ai-starter-mcp-server-stateless-webflux
197206
spring:
198207
ai:
199208
mcp:
200209
server:
201-
stateless:
202-
name: stateless-mcp-server
203-
version: 1.0.0
204-
type: ASYNC
205-
instructions: "This stateless server is optimized for cloud deployments"
210+
name: stateless-mcp-server
211+
version: 1.0.0
212+
type: ASYNC
213+
instructions: "This stateless server is optimized for cloud deployments"
214+
streamable-http:
206215
mcp-endpoint: /api/mcp
207216
----
208217

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ Due to Spring Boot's default behavior, when both `org.springframework.web.servle
6565

6666
== Configuration Properties
6767

68-
All properties are prefixed with `spring.ai.mcp.server`:
68+
=== Common Properties
69+
70+
All Common properties are prefixed with `spring.ai.mcp.server`:
6971

7072
[options="header"]
7173
|===
@@ -85,10 +87,19 @@ All properties are prefixed with `spring.ai.mcp.server`:
8587
|`prompt-change-notification` |Enable prompt change notifications |`true`
8688
|`tool-change-notification` |Enable tool change notifications |`true`
8789
|`tool-response-mime-type` |Optional response MIME type per tool name. For example, `spring.ai.mcp.server.tool-response-mime-type.generateImage=image/png` will associate the `image/png` MIME type with the `generateImage()` tool name |`-`
90+
|`request-timeout` |Duration to wait for server responses before timing out requests. Applies to all requests made through the client, including tool calls, resource access, and prompt operations |`20 seconds`
91+
|===
92+
93+
=== SSE Properties
94+
95+
All SSE properties are prefixed with `spring.ai.mcp.server`:
96+
97+
[options="header"]
98+
|===
99+
|Property |Description |Default
88100
|`sse-message-endpoint` |Custom SSE message endpoint path for web transport to be used by the client to send messages |`/mcp/message`
89101
|`sse-endpoint` |Custom SSE endpoint path for web transport |`/sse`
90102
|`base-url` |Optional URL prefix. For example, `base-url=/api/v1` means that the client should access the SSE endpoint at `/api/v1` + `sse-endpoint` and the message endpoint is `/api/v1` + `sse-message-endpoint` |`-`
91-
|`request-timeout` |Duration to wait for server responses before timing out requests. Applies to all requests made through the client, including tool calls, resource access, and prompt operations |`20 seconds`
92103
|`keep-alive-interval` |Connection keep-alive interval |`null` (disabled)
93104
|===
94105

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

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ NOTE: They require xref:api/mcp/mcp-client-boot-starter-docs#_streamable_http_tr
3636

3737
== Configuration Properties
3838

39-
All properties are prefixed with `spring.ai.mcp.server.streamable-http`:
39+
=== Common Properties
40+
41+
All common properties are prefixed with `spring.ai.mcp.server`:
4042

4143
[options="header"]
4244
|===
@@ -55,19 +57,29 @@ All properties are prefixed with `spring.ai.mcp.server.streamable-http`:
5557
|`prompt-change-notification` |Enable prompt change notifications |`true`
5658
|`tool-change-notification` |Enable tool change notifications |`true`
5759
|`tool-response-mime-type` |Response MIME type per tool name |`-`
58-
|`mcp-endpoint` |Custom MCP endpoint path |`/mcp`
5960
|`request-timeout` |Request timeout duration |`20 seconds`
61+
|===
62+
63+
=== Streamable-HTTP Properties
64+
65+
All streamable-HTTP properties are prefixed with `spring.ai.mcp.server.streamable-http`:
66+
67+
[options="header"]
68+
|===
69+
|Property |Description |Default
70+
|`mcp-endpoint` |Custom MCP endpoint path |`/mcp`
6071
|`keep-alive-interval` |Connection keep-alive interval |`null` (disabled)
72+
|`disallow-delete` |Disallow delete operations |`false`
6173
|===
6274

6375
== Features and Capabilities
6476

6577
The MCP Server supports four main capability types that can be individually enabled or disabled:
6678

67-
- **Tools** - Enable/disable tool capabilities with `spring.ai.mcp.server.streamable-http.capabilities.tool=true|false`
68-
- **Resources** - Enable/disable resource capabilities with `spring.ai.mcp.server.streamable-http.capabilities.resource=true|false`
69-
- **Prompts** - Enable/disable prompt capabilities with `spring.ai.mcp.server.streamable-http.capabilities.prompt=true|false`
70-
- **Completions** - Enable/disable completion capabilities with `spring.ai.mcp.server.streamable-http.capabilities.completion=true|false`
79+
- **Tools** - Enable/disable tool capabilities with `spring.ai.mcp.server.capabilities.tool=true|false`
80+
- **Resources** - Enable/disable resource capabilities with `spring.ai.mcp.server.capabilities.resource=true|false`
81+
- **Prompts** - Enable/disable prompt capabilities with `spring.ai.mcp.server.capabilities.prompt=true|false`
82+
- **Completions** - Enable/disable completion capabilities with `spring.ai.mcp.server.capabilities.completion=true|false`
7183

7284
All capabilities are enabled by default. Disabling a capability will prevent the server from registering and exposing the corresponding features to clients.
7385

@@ -307,15 +319,17 @@ NOTE: Currently, for streamable-http servers, the keep-alive mechanism is availa
307319
spring:
308320
ai:
309321
mcp:
310-
server:
322+
server:
323+
name: streamable-mcp-server
324+
version: 1.0.0
325+
type: SYNC
326+
instructions: "This streamable server provides real-time notifications"
327+
resource-change-notification: true
328+
tool-change-notification: true
329+
prompt-change-notification: true
311330
streamable-http:
312-
name: streamable-mcp-server
313-
version: 1.0.0
314-
type: SYNC
315-
instructions: "This streamable server provides real-time notifications"
316-
resource-change-notification: true
317-
tool-change-notification: true
318-
prompt-change-notification: true
331+
mcp-endpoint: /api/mcp
332+
keep-alive-interval: 30s
319333
----
320334

321335

0 commit comments

Comments
 (0)