ModelContextProtocol C SDK：如何为第三方类添加字段描述

在开发基于ModelContextProtocol C# SDK的工具时，我们经常会遇到需要将第三方类作为工具输入参数的情况。这些第三方类通常没有包含足够的元数据描述，这会影响AI对输入参数的理解和使用。本文将介绍如何优雅地为这些第三方类添加字段描述信息。

问题背景

当我们在工具方法中使用第三方类作为参数时，例如：

public CallToolResponse testTool(Foo foo)
{
    return new CallToolResponse()
    {
        Content = [new Content { Text = "hello") }],
        IsError = false
    };
}

其中Foo类可能来自第三方库，结构可能很复杂，包含嵌套类和继承关系：

class ParentOfFoo
{
   string myStr;
}

class Foo : ParentOfFoo
{
    Bar bar;
}

class Bar
{
   Baz baz;
}

class Baz
{
   int myInt;
}

默认情况下，SDK生成的输入模式(InputSchema)不会包含这些字段的描述信息，这会影响AI对参数的理解。

解决方案

ModelContextProtocol C# SDK提供了SchemaCreateOptions.TransformSchemaNode属性，允许我们通过委托来定制生成的模式文档。这个功能位于McpServerToolCreateOptions中。

实现步骤

1. 创建模式转换器：编写一个委托方法，用于检查和修改模式节点

2. 配置工具创建选项：在创建工具时设置转换器

3. 应用描述信息：在转换器中根据类型或成员信息添加描述

示例代码

var options = new McpServerToolCreateOptions
{
    SchemaCreateOptions = new()
    {
        TransformSchemaNode = (schemaNode, context) =>
        {
            // 为字段添加描述
            if (context.MemberInfo is PropertyInfo property)
            {
                schemaNode.Description = GetDescriptionForProperty(property);
            }
            else if (context.Type != null)
            {
                schemaNode.Description = GetDescriptionForType(context.Type);
            }
            
            return schemaNode;
        }
    }
};

// 创建工具时传入选项
var tool = mcpServer.CreateTool(testTool, options);

描述信息获取策略

你可以根据实际需求实现GetDescriptionForProperty和GetDescriptionForType方法，常见策略包括：

1. 硬编码字典：为已知类型和属性建立描述字典
2. 命名约定：根据属性名自动生成描述
3. 外部配置文件：从JSON或XML文件加载描述
4. 反射分析：通过分析类型和属性名生成基础描述

最佳实践

1. 保持一致性：确保同类属性的描述风格一致
2. 简明扼要：描述应简洁明了，便于AI理解
3. 覆盖全面：为所有重要字段添加描述
4. 分层处理：优先处理常用类和关键属性
5. 可维护性：考虑将描述信息集中管理

总结

通过使用ModelContextProtocol C# SDK提供的模式转换功能，我们可以灵活地为第三方类添加字段描述，而无需修改原始代码。这种方法既保持了代码的整洁性，又提供了AI所需的元数据信息，是处理第三方类集成的优雅解决方案。

对于大型项目，建议建立一个集中的描述信息管理系统，可以结合命名约定和外部配置文件，实现描述信息的统一管理和维护。