Skip to content

Read stdio messages as UTF-8 without a string copy and add StreamServerTransportOptions.MaxMessageSize #2016

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
asawicki wants to merge 1 commit into
base: main
Choose a base branch
from
+1,608 −65
Open

Read stdio messages as UTF-8 without a string copy and add StreamServerTransportOptions.MaxMessageSize #2016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/concepts/transports/transports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,16 @@ builder.Services.AddMcpServer()
await builder.Build().RunAsync();
```

By default, the stdio server accepts a message of any size and buffers each line until its newline arrives. To bound the memory used to read one message, set <xref:ModelContextProtocol.Server.StreamServerTransportOptions.MaxMessageSize>:

```csharp
builder.Services.AddMcpServer()
.WithStdioServerTransport(options => options.MaxMessageSize = 32 * 1024 * 1024)
.WithTools<MyTools>();
```

A request over the limit is discarded without being buffered whole and is answered with a JSON-RPC `-32600` (invalid request) error for its id. A response over the limit, such as a large sampling result, fails the server's pending request instead. The same option applies to <xref:ModelContextProtocol.Server.StreamServerTransport>.

### Streamable HTTP transport

The [Streamable HTTP] transport uses HTTP for bidirectional communication with optional streaming. This is the recommended transport for remote servers.
Expand Down
Loading