Skip to content

Commit 1f35f41

Browse files
committed
docs(getting-started): Add new section for streamable server configuration
1 parent 7ec1d48 commit 1f35f41

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

docs/docs/getting-started.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ For the method `startSseServer`, you can specify the server information by using
144144
| `baseUrl` | String | The base URL of the MCP server | (empty string) |
145145
| `messageEndpoint` | String | The endpoint of the MCP server message | `/mcp/message` |
146146
| `sseEndpoint` | String | The endpoint for HTTP SSE mode | `/sse` |
147-
| `port` | int | The port for HTTP SSE mode | `8080` |
147+
| `port` | int | The port for HTTP Server | `8080` |
148148

149149
#### How to run
150150

@@ -172,6 +172,25 @@ public class McpStreamableServer {
172172
}
173173
```
174174

175+
#### Server Info
176+
177+
For the method `startStreamableServer`, you can specify the server information by using `McpStreamableServerInfo`:
178+
179+
| Field | Type | Description | Default Value |
180+
|---------------------|----------|------------------------------------------------------------------------------|----------------|
181+
| `name` | String | The name of the MCP server | `mcp-server` |
182+
| `version` | String | The version of the MCP server | `1.0.0` |
183+
| `instructions` | String | The instructions of the MCP server | (empty string) |
184+
| `requestTimeout` | Duration | The timeout of the MCP server request | `20` seconds |
185+
| `mcpEndpoint` | String | The endpoint of the MCP server message | `/mcp` |
186+
| `disallowDelete` | boolean | Whether to disable the DELETE method of HTTP | `false` |
187+
| `keepAliveInterval` | Duration | The interval for keep-alive pings. No keep-alive will be scheduled if `null` | `null` |
188+
| `port` | int | The port for HTTP server | `8080` |
189+
190+
#### How to run
191+
192+
Just run the main class like you would launch a web application, and then it's all set.
193+
175194
## MCP Component
176195

177196
In the previous section, we have learned how to create a MCP server, but the server still has no usable components, like

0 commit comments

Comments
 (0)