如何把ASP.NET Core WebApi打造成Mcp Server
前言
MCP (Model Context Protocol)即模型上下文协议目前不要太火爆了,关于它是什么相信大家已经很熟悉了。目前主流的AI开发框架和AI工具都支持集成MCP
,这也正是它的意义所在。毕竟作为一个标准的协议,当然是更多的生态接入进来才会有意义。使用MCP我们可以把Tools调用标准化
,这意味着我们可以忽略语言、框架快速把工具融合到不同的模型中去。现在,如何把现有的业务逻辑快速的接入到模型中,成为模型落地很关键的一步,今天我们就借助微软的Semantic Kernel
和Microsoft.Extensions.AI
框架,通过简单的示例展示,如何把现有的ASP NET Core WebApi
转换成MCP Server
。
概念相关
接下来我们大致介绍一下本文设计到的相关的概念以及涉及到的相关类库
MCP
MCP是一个开放协议,它为应用程序向 LLM 提供上下文的方式进行了标准化。它的重点是标准化,而不是取代谁。它涉及到几个核心的概念
- MCP Hosts: 如
Claude Desktop
、IDE
、AI
工具、或者是你开发的AI程序等 - MCP Clients: 维护与
MCP Servers
一对一连接的协议客户端 - MCP Servers: 轻量级程序,通过标准的
Model Context Protocol
提供特定能力
简单来说就是你写的AI应用就是MCP Hosts
,因为MCP
是一个协议,所以你需要通过MCP Clients
访问MCP Servers
,MCP Servers
提供的就是工具或者一些其他能力。需要说明的是,如果想在AI应用中使用MCP
,模型需要支持Function Calling
,当然如果你能通过提示词
的方式调试出来也是可以的,但是效果肯定不如本身就支持Function Calling
。
因为MCP是一个开放协议,所以我们可以把原来固定在AI应用里的工具代码单独抽离出来,使用不同的开发语言形成独立的应用,这样这个Tools应用就可以和AI应用隔离,他们可以不是同一种语言,甚至可以在不同的机器上。所以现在很多开源的组件和平台都可以提供自己的MCP Server
了。就和没有微服务概念之前我们代码都写到一个项目里,有了微服务之后我们可以把不同的模块形成单独的项目,甚至可以使用不同的开发语言。可以通过HTTP、RPC等多种方式进行通信。
框架
简单介绍一下本文涉及到的相关框架及地址:
Microsoft.Extensions.AI:微软提供的通过.NET实现AIGC操作的开发基础框架,提供了基础
对话
和Function Calling
等基础操作,使用简单扩展性强,支持OTEL要测协议监控模型调用情况。目前已适配Ollama、OpenAI、Azure OpenAI等。项目地址https://github.com/dotnet/extensions/tree/main/src/Libraries/Microsoft.Extensions.AISemantic Kernel:以
Microsoft.Extensions.AI
为基础(低版本的不是)打造的更强大的AI开发框架,提供了基础对话
和Function Calling
功能的同时,还提供了多模态、RAG、智能体、流程处理等强大的应用级功能,有.NET、Python、Java三种语言版本。项目地址https://github.com/microsoft/semantic-kernelmcpdotnet(modelcontextprotocol/csharp-sdk):原名为mcpdotnet,现在是.NET构建MCP的官方项目,可以使的Microsoft.Extensions.AI和Semantic Kernel快速的适配到MCP。项目地址https://github.com/modelcontextprotocol/csharp-sdk
实现
整体来说实现的思路也很简单,因为Semantic Kernel
支持加载OpenAPI
格式的数据加载成它的Plugins
,我们可以把Plugins
转换成Microsoft.Extensions.AI
提供的标准的AIFunction
类型,通过mcpdotnet
可以把AIFunction
标准类型转换成mcpdotnet
的Tools
。
WebApi
我们需要新建一个ASP.NET Core WebAPI
项目,用来完成查询天气的功能。首先,添加Swagger
支持。当然你使用别的库也可以,这里的重点就是可以得到该项目接口的OpenAPI
数据信息。
<PackageReference Include="Swashbuckle.AspNetCore" Version="8.1.1" />
其次,添加根据IP查询地址信息的功能
<PackageReference Include="IPTools.China" Version="1.6.0" />
因为IPTools
使用的是sqlite
数据库,所以需要把db加载到项目里。具体使用细节可以查看该库的具体地址https://github.com/stulzq/IPTools
<ItemGroup>
<None Update="ip2region.db">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</None>
</ItemGroup>
接下来实现具体功能的Controller
代码
/// <summary>
/// 获取城市天气
/// </summary>
[ApiController]
[Route("api/[controller]/[action]")]
public class WeatherController(IHttpClientFactory _httpClientFactory) : ControllerBase
{
/// <summary>
/// 获取当前时间
/// </summary>
/// <returns>当前时间</returns>
[HttpGet]
public string GetCurrentDate()
{
return DateTime.Now.ToString("MM/dd");
}
/// <summary>
/// 获取当前城市信息
/// </summary>
/// <returns>当前城市信息</returns>
[HttpGet]
public async Task<IpInfo> GetLocation()
{
var httpClient = _httpClientFactory.CreateClient();
IpData ipInfo = await httpClient.GetFromJsonAsync<IpData>("https://ipinfo.io/json");
var ipinfo = IpTool.Search(ipInfo!.ip);
return ipinfo;
}
/// <summary>
/// 获取天气信息
/// </summary>
/// <param name="region">省份</param>
/// <param name="city">城市</param>
/// <param name="currentDate">日期(格式:月份/日期)</param>
/// <returns>天气信息</returns>
[HttpGet]
public async Task<string> GetCurrentWeather(string region, string city, string currentDate)
{
var httpClient = _httpClientFactory.CreateClient();
WeatherRoot weatherRoot = await httpClient.GetFromJsonAsync<WeatherRoot>($"https://cn.apihz.cn/api/tianqi/tqybmoji15.php?id=88888888&key=88888888&sheng={region!}&place={city!}")!;
DataItem today = weatherRoot!.data!.FirstOrDefault(i => i.week2 == currentDate)!;
return $"{today!.week2} {today.week1},天气{today.wea1}转{today.wea2}。最高气温{today.wendu1}摄氏度,最低气温{today.wendu2}摄氏度。";
}
}
public class IpData
{
public string ip { get; set; }
public string city { get; set; }
public string region { get; set; }
public string country { get; set; }
public string loc { get; set; }
public string org { get; set; }
public string postal { get; set; }
public string timezone { get; set; }
public string readme { get; set; }
}
public class DataItem
{
public string week1 { get; set; }
public string week2 { get; set; }
public string wea1 { get; set; }
public string wea2 { get; set; }
public string wendu1 { get; set; }
public string wendu2 { get; set; }
public string img1 { get; set; }
public string img2 { get; set; }
}
public class WeatherRoot
{
public List<DataItem> data { get; set; }
public int code { get; set; }
public string place { get; set; }
}
代码里实现了三个action,分别是获取城市天气、获取当前城市信息、获取天气信息接口。接下来添加项目配置
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo
{
Version = "v1",
Title = "",
Description = "",
});
var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename));
});
builder.Services.AddHttpClient();
var app = builder.Build();
//使用OpenApi的版本信息
app.UseSwagger(options =>
{
options.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0;
});
app.UseSwaggerUI(options =>
{
options.SwaggerEndpoint("/swagger/v1/swagger.json", "v1");
});
app.UseAuthorization();
app.MapControllers();
app.Run();
完成上面的代码之后,可以运行起来该项目。通过http://项目地址:端口/swagger/v1/swagger.json
获取WebApi
接口的OpenAPI
的数据格式。
MCP Server
接下来搭建MCP Server
项目,来把上面的WebApi
项目转换成MCP Server
。首先添加MCP
和SemanticKernel OpenApi
涉及到的类库,因为我们需要使用SemanticKernel
来把swagger.json
加载成Plugins
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
<PackageReference Include="Microsoft.SemanticKernel.Plugins.OpenApi" Version="1.47.0" />
<PackageReference Include="ModelContextProtocol" Version="0.1.0-preview.11" />
</ItemGroup>
接下来我们来编写具体的代码实现
IKernelBuilder kernelBuilder = Kernel.CreateBuilder();;
Kernel kernel = kernelBuilder.Build();
#pragma warning disable SKEXP0040
//把swagger.json加载成Plugin
//这里也可以是本地路径或者是文件流
await kernel.ImportPluginFromOpenApiAsync(
pluginName: "city_date_weather",
uri: new Uri("http://localhost:5021/swagger/v1/swagger.json"),
executionParameters: new OpenApiFunctionExecutionParameters
{
EnablePayloadNamespacing = true
}
);
#pragma warning restore SKEXP0040
var builder = Host.CreateEmptyApplicationBuilder(settings: null);
builder.Services
//添加MCP Server
.AddMcpServer()
//使用Stdio模式
.WithStdioServerTransport()
//把Plugins转换成McpServerTool
.WithTools(kernel.Plugins);
await builder.Build().RunAsync();
public static class McpServerBuilderExtensions
{
/// <summary>
/// 把Plugins转换成McpServerTool
/// </summary>
public static IMcpServerBuilder WithTools(this IMcpServerBuilder builder, KernelPluginCollection plugins)
{
foreach (var plugin in plugins)
{
foreach (var function in plugin)
{
builder.Services.AddSingleton(services => McpServerTool.Create(function.AsAIFunction()));
}
}
return builder;
}
}
MCP的传输层协议可以使用
stdio(既标准输入输出)
、sse
或者是streamable
,甚至是自定义的方式进行通信。其中stdio
可以本机进程间通信,sse
或者是streamable
进行远程通信。它的消息格式,或者理解为数据传输的格式是JSON-RPC 2.0
。
其中ImportPluginFromOpenApiAsync
方法是其中比较关键的点,它是把OpenApi
接口信息转换成Kernel Plugins
。它通过读取swagger.json
里的接口信息的元数据构建成KernelFunction
实例,而具体的触发操作则转换成Http调用。具体的实现方式可以通过阅读CreateRestApiFunction方法源码的实现。
再次AsAIFunction
方法则是把KernelFunctionFromMethod
转换成KernelAIFunction
,因为KernelFunctionFromMethod
是继承了KernelFunction
类,KernelAIFunction
则是继承了AIFunction
类,所以这个操作是把KernelFunction
转换成AIFunction
。可以把KernelAIFunction
理解成KernelFunction
的外观类,它只是包装了KernelFunction
的操作,所以触发的时候还是KernelFunctionFromMethod
里的操作。具体的实现可以查看KernelAIFunction类的实现。
几句简单的代码既可以实现一个Mcp Server
,虽然上面我们使用的是Uri
的方式加载的OpenAPI
文档地址,但是它也支持本地文件地址
或者文件流
的方式。不得不说微软体系下的框架在具体的落地方面做得确实够实用,因为具体的逻辑都是WebApi
实现的,Mcp Server
只是一个媒介。
MCP Client
最后实现的是MCP Client
是为了验证Mcp Server
效果用的,这里可以使用任何框架来实现,需要引入ModelContextProtocol
和具体的AI框架,AI框架可以是Microsoft.Extensions.AI
,也可以是Semantic Kernel
。这里我们使用Microsoft.Extensions.AI
,因为它足够简单也足够简洁,引入相关的类库
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.AI.OpenAI" Version="9.4.3-preview.1.25230.7" />
<PackageReference Include="ModelContextProtocol" Version="0.1.0-preview.12" />
</ItemGroup>
其中ModelContextProtocol
提供了McpClient
功能,Microsoft.Extensions.AI
提供具体的AI功能集成。具体实现如下所示
//加载McpServer,以为我们构建的是使用Stdio的方式,所以这里直接使用McpServer路径即可
await using IMcpClient mcpClient = await McpClientFactory.CreateAsync(new StdioClientTransport(new()
{
Name = "city_date_weather",
Command = "..\\..\\..\\..\\McpServerDemo\\bin\\Debug\\net9.0\\McpServerDemo.exe"
}));
//加载MCP Tools
var tools = await mcpClient.ListToolsAsync();
foreach (AIFunction tool in tools)
{
Console.WriteLine($"Tool Name: {tool.Name}");
Console.WriteLine($"Tool Description: {tool.Description}");
Console.WriteLine();
}
//中文的function calling,国内使用qwen-max系列效果最好
string apiKey = "sk-****";
var chatClient = new ChatClient("qwen-max-2025-01-25", new ApiKeyCredential(apiKey), new OpenAIClientOptions
{
Endpoint = new Uri("https://dashscope.aliyuncs.com/compatible-mode/v1")
}).AsIChatClient();
IChatClient client = new ChatClientBuilder(chatClient)
//开启function calling支持
.UseFunctionInvocation()
.Build();
//构建Tools
ChatOptions chatOptions = new()
{
Tools = [.. tools],
};
//创建对话代码
List<Microsoft.Extensions.AI.ChatMessage> chatList = [];
string question = "";
do
{
Console.Write($"User:");
question = Console.ReadLine();
if (string.IsNullOrWhiteSpace(question) || question == "exists")
{
break;
}
chatList.Add(new Microsoft.Extensions.AI.ChatMessage(ChatRole.User, question));
Console.Write($"Assistant:");
StringBuilder sb = new StringBuilder();
await foreach (var update in client.GetStreamingResponseAsync(chatList, chatOptions))
{
if (string.IsNullOrWhiteSpace(update.Text))
{
continue;
}
sb.Append(update.Text);
Console.Write(update.Text);
}
chatList.Add(new Microsoft.Extensions.AI.ChatMessage(ChatRole.Assistant, sb.ToString()));
Console.WriteLine();
} while (true);
Console.ReadLine();
上面的代码实现了McpClient
接入AI应用
- 首先,通过
McpClient
加载McpServer
里的工具 - 其次,把
MCP Tools
加载到Microsoft.Extensions.AI
里 - 最后,在和AI模型对话的时候把Tools转换成
function calling
。中文的function calling
,个人体验下来国内使用qwen-max
系列效果最好
其中mcpClient.ListToolsAsync()
获取到的是McpClientTool
集合,而McpClientTool
继承自AIFunction
类,具体可查看McpClientTool实现源码。由此可以看出微软封装Microsoft.Extensions.AI
基座的重要性,以后更多的框架都可以围绕Microsoft.Extensions.AI
进行封装统一操作,这样大大提升了扩展的便捷性。
当然,你也可以使用Semantic Kernel
框架进行上面的操作,这里就不过多赘述了,直接上代码
//加载McpServer,以为我们构建的是使用Stdio的方式,所以这里直接使用McpServer路径即可
await using IMcpClient mcpClient = await McpClientFactory.CreateAsync(new StdioClientTransport(new()
{
Name = "city_date_weather",
Command = "..\\..\\..\\..\\McpServerDemo\\bin\\Debug\\net9.0\\McpServerDemo.exe"
}));
//加载MCP Tools
var tools = await mcpClient.ListToolsAsync();
using HttpClientHandler handler = new HttpClientHandler
{
ClientCertificateOptions = ClientCertificateOption.Automatic
};
using HttpClient httpClient = new(handler)
{
BaseAddress = new Uri("https://dashscope.aliyuncs.com/compatible-mode/v1")
};
#pragma warning disable SKEXP0070
IKernelBuilder kernelBuilder = Kernel.CreateBuilder();
kernelBuilder.AddOpenAIChatCompletion("qwen-max-2025-01-25", "sk-***", httpClient: httpClient);
//把Tools加载成sk的Plugins
kernelBuilder.Plugins.AddFromFunctions("weather", tools.Select(aiFunction => aiFunction.AsKernelFunction()));
Kernel kernel = kernelBuilder.Build();
var chatCompletionService = kernel.GetRequiredService<IChatCompletionService>();
PromptExecutionSettings promptExecutionSettings = new()
{
FunctionChoiceBehavior = FunctionChoiceBehavior.Auto()
};
var history = new ChatHistory();
while (true)
{
Console.Write($"User:");
string input = Console.ReadLine();
if (string.IsNullOrWhiteSpace(input) || input == "exists")
{
break;
}
history.AddUserMessage(input);
var chatMessage = await chatCompletionService.GetChatMessageContentAsync(
history,
executionSettings: promptExecutionSettings,
kernel: kernel);
Console.WriteLine("Assistant:" + chatMessage.Content);
history.AddAssistantMessage(chatMessage.Content);
}
Console.ReadLine();
因为MCP
是一个协议标准,所以MCP Server
可以做到一次构建,到处使用。
运行效果
运行的时候需要先运行起来WebApi
项目,然后把McpServer
编译成exe
文件,然后运行McpClient
项目,我们打印出来了可用的Tools
列表。在Client项目进行对话,询问当前天气效果如下
感兴趣的如果想运行具体的代码示例,可以查看我上传的代码示例https://github.com/softlgl/McpDemo
总结
本文演示了如何把ASP.NET Core WebApi打造成Mcp Server,通过讲解基本概念,介绍使用的框架,以及简单的示例展示了这一过程,整体来说是比较简单的。MCP
的重点是标准化,而不是取代。如果想在AI应用中使用MCP
,模型需要支持Function Calling
.我们可以把原来固定在AI应用里的工具代码单独抽离出来,形成独立的应用,这样这个Tools应用就可以和AI应用隔离,形成独立可复用的工具。
现在AI大部分时候确实很好用,但是它也不是银弹。至于它的边界在哪里,只有不断地使用实践。你身边的事情都可以先用AI尝试去做,不断地试探它的能力。AI帮你做完的事情,如果能达到你的预期,你可以看它的实现方式方法,让自己学习到更好的思路。如果是完全依赖AI,而自己不去思考,那真的可能会被AI取代掉。只有你自己不断的进步,才能进一步的探索AI,让它成为你的好工具。

如何把ASP.NET Core WebApi打造成Mcp Server的更多相关文章
- asp.net core webapi之跨域(Cors)访问
这里说的跨域是指通过js在不同的域之间进行数据传输或通信,比如用ajax向一个不同的域请求数据,或者通过js获取页面中不同域的框架中(iframe)的数据.只要协议.域名.端口有任何一个不同,都被当作 ...
- ASP.NET Core WebAPI 开发-新建WebAPI项目
ASP.NET Core WebAPI 开发-新建WebAPI项目, ASP.NET Core 1.0 RC2 即将发布,我们现在来学习一下 ASP.NET Core WebAPI开发. 网上已经有泄 ...
- Asp.net Core WebApi 使用Swagger做帮助文档,并且自定义Swagger的UI
WebApi写好之后,在线帮助文档以及能够在线调试的工具是专业化的表现,而Swagger毫无疑问是做Docs的最佳工具,自动生成每个Controller的接口说明,自动将参数解析成json,并且能够在 ...
- Asp.Net Core WebApi学习笔记(四)-- Middleware
Asp.Net Core WebApi学习笔记(四)-- Middleware 本文记录了Asp.Net管道模型和Asp.Net Core的Middleware模型的对比,并在上一篇的基础上增加Mid ...
- Asp.net core WebApi 使用Swagger生成帮助页
最近我们团队一直进行.net core的转型,web开发向着前后端分离的技术架构演进,我们后台主要是采用了asp.net core webapi来进行开发,开始每次调试以及与前端人员的沟通上都存在这效 ...
- ASP.Net Core WebApi几种版本控制对比
版本控制的好处: (1)助于及时推出功能, 而不会破坏现有系统. (2)它还可以帮助为选定的客户提供额外的功能. API 版本控制可以采用不同的方式进行控制,方法如下: (1)在 URL 中追加版本或 ...
- ASP.NET Core WebApi 返回统一格式参数(Json 中 Null 替换为空字符串)
相关博文:ASP.NET Core WebApi 返回统一格式参数 业务场景: 统一返回格式参数中,如果包含 Null 值,调用方会不太好处理,需要替换为空字符串,示例: { "respon ...
- ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了
引言 在使用asp.net core 进行api开发完成后,书写api说明文档对于程序员来说想必是件很痛苦的事情吧,但文档又必须写,而且文档的格式如果没有具体要求的话,最终完成的文档则完全取决于开发者 ...
- Asp.Net Core WebApi中接入Swagger组件(初级)
开发WebApi时通常需要为调用我们Api的客户端提供说明文档.Swagger便是为此而存在的,能够提供在线调用.调试的功能和API文档界面. 环境介绍:Asp.Net Core WebApi + S ...
- Asp.Net Core WebApi (Swagger+EF Core/Code First)
Swagger简介: Swagger™的目标是为REST APIs 定义一个标准的,与语言无关的接口,使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能. ...
随机推荐
- 使用docker-compose 部署本地apollo
注意: Mysql 需要自己安装本教程只提供apollo的安装和部署 拉取镜像 docker pull apolloconfig/apollo-portal docker pull apollocon ...
- 天线的OTA测试
有源测试 (即OTA测试) 把使用综测仪的测试叫做有源测试(Active).使用有源测试的测试速度比较无源相对要慢,但是因为手机是一个复杂材料体,往往无源测试对发射性能的模拟是可信的,但是对于接收性能 ...
- Ansible - [11] Roles
前言 Q1:什么是Roles 在实际生产环境中,会编写大量的playbook文件来实现不同的功能.而且,每个playbook还可能会调用其他文件(变量文件),对于海量的.无规律的文件,管理是个问题.A ...
- 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析
从 Chrome 125 开始,支持了一个全新的 CSS 特性 - Anchor Positioning,翻译过来即是锚点定位. 在之前的文章中,我们较为系统的讲述了这个新特性的使用,感兴趣的可以翻开 ...
- Cordova基本使用(二)
cordova的打包发布版app流程简介 除了第一遍官网给的打包发布版的方法,我们可以自己多敲几次命令来实现. 基本上使用如下的几个命令就完成这个过程,先列出整个过程: 1.cordova选定ando ...
- TypeScript 为什么使用 Go 而不是 Rust 重写 ?官方回应来了
TypeScript官推最近宣布他们正在移植到 Go,速度已经提高了 10 倍之多. 作为以性能为代表的另一语言Rust,人们自然会疑惑为什么没有选Rust语言重构呢?为方便大家快速理解,我用Deep ...
- docker clean images
docker ps | grep portal | awk '{print $2}' | cut -d ":" -f3 used=`docker ps | grep portal ...
- 窗体添加按钮--java进阶day03
1.组件.面板对象 窗体中的图片.按钮.文本都是组件,光创建出了窗体没有组件肯定不行,但是这些组件该放到窗体的哪个位置? 很明显是窗体中空白的位置,但是我们需要知道,这块空白位置在窗体中是一个被封装的 ...
- DevOps工程师技能
技术背景 DevOps工程师必须持有计算机科学.工程或其他相关领域的学位.2年以上工作经验.这包括开发人员.系统管理员或devops驱动的团队成员的工作.这是一个重要的需求,同时也是对所有IT操作的理 ...
- 目前国内可用Docker镜像源汇总(截至2024年11月)
本文主要讲述了由于特殊原因国内的 Docker 镜像源出现问题,国内许多常见的镜像源如网易.百度等已不可用.文中介绍了中科大镜像源的暂时关闭情况,以及阿里镜像源包括私人阿里镜像加速器的使用方式,并提供 ...