ModelContextProtocol C SDK 文件返回功能实现详解

在开发基于ModelContextProtocol C# SDK的工具时，我们经常需要处理非文本类型的返回结果，例如图片、PDF等二进制文件。本文将深入探讨如何在SDK中实现文件返回功能。

核心实现方案

SDK提供了DataContent类作为处理二进制数据的核心解决方案。这个类专门设计用于封装各种类型的二进制内容，并支持设置MIME类型标识。

基本实现方法

最直接的实现方式是使用DataContent类包装文件字节数组：

[McpServerTool]
public static DataContent GetImageFile()
{
    byte[] fileBytes = File.ReadAllBytes("example.png");
    return new DataContent(fileBytes, "image/png");
}

关键特性解析

1. 二进制数据支持：DataContent可以封装任意二进制数据，如图片、音频、视频等
2. MIME类型标识：通过构造函数参数指定内容类型，确保接收方能正确解析
3. 工具方法集成：通过[McpServerTool]属性标记，使方法可作为工具API暴露

高级应用场景

动态内容生成

除了读取静态文件，我们还可以动态生成内容：

[McpServerTool]
public static DataContent GenerateChart()
{
    using var chartStream = new MemoryStream();
    // 使用图表库生成图表
    chart.SaveAsPng(chartStream);
    return new DataContent(chartStream.ToArray(), "image/png");
}

大文件处理

对于大文件，建议使用流式处理避免内存问题：

[McpServerTool]
public static async Task<DataContent> GetLargeFileAsync()
{
    using var fs = new FileStream("largefile.zip", FileMode.Open);
    using var ms = new MemoryStream();
    await fs.CopyToAsync(ms);
    return new DataContent(ms.ToArray(), "application/zip");
}

最佳实践建议

1. 始终指定正确的MIME类型
2. 对于大于10MB的文件考虑分块传输
3. 在异步方法中使用异步IO操作
4. 注意资源清理，及时释放文件句柄
5. 考虑添加文件校验机制

异常处理

完善的实现应该包含错误处理：

[McpServerTool]
public static DataContent GetFileSafely(string path)
{
    try
    {
        if (!File.Exists(path))
            throw new FileNotFoundException();
            
        return new DataContent(File.ReadAllBytes(path), GetMimeType(path));
    }
    catch (Exception ex)
    {
        // 记录日志或返回错误信息
        throw;
    }
}

通过上述方法，开发者可以轻松地在ModelContextProtocol C# SDK中实现文件返回功能，满足各种业务场景需求。