首页
/ ModelContextProtocol C SDK:如何为第三方类添加字段描述

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

2025-07-08 08:16:36作者:温玫谨Lighthearted

在开发基于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);

描述信息获取策略

你可以根据实际需求实现GetDescriptionForPropertyGetDescriptionForType方法,常见策略包括:

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

最佳实践

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

总结

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

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

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511