From 87f5b09b24928912e5033c4ea1b9c2640579c06e Mon Sep 17 00:00:00 2001
From: Akbar Dizaji <72616525+AkbarDizaji@users.noreply.github.com>
Date: Tue, 4 Aug 2026 21:40:52 +0200
Subject: [PATCH] Add README for the InMemoryTransport sample (#1769)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Akbar Dızajı <akbar@skedda.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
---
 samples/InMemoryTransport/README.md | 42 +++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 samples/InMemoryTransport/README.md

diff --git a/samples/InMemoryTransport/README.md b/samples/InMemoryTransport/README.md
new file mode 100644
index 0000000..e350144
--- /dev/null
+++ b/samples/InMemoryTransport/README.md
@@ -0,0 +1,42 @@
+# In-Memory Transport Sample
+
+Demonstrates connecting an MCP client and server in the same process using stream-based
+transports over in-memory pipes (`System.IO.Pipelines`) — no child process, no network.
+
+The server is created directly with `McpServer.Create`, without a host or dependency
+injection container, and exposes a single `Echo` tool defined from a delegate with
+`McpServerTool.Create`. The client connects over the same pipe pair with
+`StreamClientTransport`, lists the server's tools, and invokes the tool.
+
+This pattern is useful for testing MCP servers, embedding a server inside a larger
+application, or running a client and server in the same process without transport overhead.
+See [Transports: In-memory transport](../../docs/concepts/transports/transports.md) for more
+background.
+
+## Run
+
+```bash
+dotnet run --project samples/InMemoryTransport/InMemoryTransport.csproj
+```
+
+Expected output:
+
+```
+Tool Name: Echo
+
+Echo: Hello World
+```
+
+## Key files
+
+- [`Program.cs`](Program.cs) — the entire sample: pipe setup, server creation, client
+  connection, tool listing, and tool invocation.
+
+## Notes
+
+- `StreamServerTransport` and `StreamClientTransport` work with any `Stream`. This sample
+  wires them to a pair of `Pipe` instances, one per direction; the client's output stream is
+  the server's input stream and vice versa.
+- The server is started with a fire-and-forget `server.RunAsync()` because both endpoints
+  live in the same process. `await using` on the server and client ensures both are disposed
+  when the program exits.