ModelContextProtocol C SDK中同一进程内客户端与服务端通信的解决方案

背景介绍

在使用ModelContextProtocol C# SDK进行开发时，开发者Chrisdf遇到了一个典型问题：当尝试在同一进程内同时运行客户端和服务端时，系统会出现挂起现象。这种情况在需要构建自包含应用程序时尤为常见，特别是在Unity游戏开发环境中。

问题现象

开发者最初尝试通过以下方式启动服务端：

await _host.StartAsync(); // 非阻塞方式启动主机

然而，这种实现方式导致了服务端在接收到客户端消息后出现挂起，无法继续处理后续请求。这种情况在两种传输方式下都会出现：

1. 使用TCP回环(loopback)通信
2. 使用内存管道(in-memory pipe)通信

根本原因分析

经过项目维护者stephentoub的诊断，发现问题出在服务端的启动方式上。正确的做法应该是使用RunAsync方法而非StartAsync方法来启动服务端。这两种方法在行为上有重要区别：

• RunAsync：会启动服务并开始处理传入请求
• StartAsync：仅准备服务但不自动开始处理请求

解决方案

stephentoub提供了一个完整的工作示例，展示了如何正确地在同一进程内实现客户端与服务端的通信：

// 创建双向通信管道
Pipe clientToServerPipe = new(), serverToClientPipe = new();

// 创建并启动服务端
IMcpServer server = McpServerFactory.Create(
    new StreamServerTransport(clientToServerPipe.Reader.AsStream(), 
                           serverToClientPipe.Writer.AsStream()),
    new McpServerOptions()
    {
        Capabilities = new()
        {
            Tools = new()
            {
                ToolCollection = [McpServerTool.Create((string arg) => $"Echo: {arg}", 
                                     new() { Name = "Echo" })]
            }
        }
    });
_ = server.RunAsync(); // 关键点：使用RunAsync而非StartAsync

// 创建客户端
IMcpClient client = await McpClientFactory.CreateAsync(
    new StreamClientTransport(clientToServerPipe.Writer.AsStream(), 
                            serverToClientPipe.Reader.AsStream()));

// 使用客户端调用服务端功能
var tools = await client.ListToolsAsync();
foreach (var tool in tools)
{
    Console.WriteLine($"Tool Name: {tool.Name}");
}

var echo = tools.First(t => t.Name == "Echo");
Console.WriteLine(await echo.InvokeAsync(new()
{
    ["arg"] = "Hello World"
}));

技术要点

1. 管道通信机制：示例中使用了两组Pipe实现全双工通信，这是进程内高效通信的常见模式。

2. 服务端配置：通过McpServerOptions可以灵活配置服务端能力，包括工具集合等。

3. 工具定义：示例中定义了一个简单的Echo工具，展示了如何创建和注册自定义工具。

4. 异步处理：整个通信过程采用异步模式，确保不会阻塞主线程。

实际应用建议

对于需要在Unity等游戏引擎中集成ModelContextProtocol的开发者，建议：

1. 将服务端运行在独立的协程中，避免阻塞游戏主线程。

2. 考虑使用内存管道通信方式，减少序列化开销。

3. 合理设计工具接口，保持每个工具功能的单一性。

4. 注意异常处理，特别是在工具调用过程中。

总结

通过正确使用RunAsync方法，开发者可以成功地在同一进程内实现ModelContextProtocol客户端与服务端的通信。这一解决方案不仅解决了最初的挂起问题，还展示了SDK的核心功能和使用模式，为开发者构建自包含应用程序提供了可靠的技术基础。