Model Context Protocol .NET Template

Model Context Protocol .NET 模板

用于大模型应用与外部数据源之间无缝集成的协议

文档 | 规范 | 讨论

本仓库包含一个模板，用于在 .NET 中创建 Model Context Protocol (MCP) 应用。它提供了基本结构和示例代码，帮助你开始构建自己的支持 MCP 的应用。

包	版本	描述
Nall.ModelContextProtocol.Template		模板
Nall.ModelContextProtocol.Inspector.Aspire.Hosting		Aspire 托管集成

快速开始

安装：

dotnet new install Nall.ModelContextProtocol.Template
# dotnet new install ./Artefact/Nall.ModelContextProtocol.Template

验证安装：

dotnet new list mcp
# These templates matched your input: 'mcp'

# Template Name      Short Name         Language  Tags
# -----------------  -----------------  --------  -------------
# Template Name         Short Name            Language  Tags
# --------------------  --------------------  --------  -------------
# MCP Server            mcp-server            [C#]      dotnet/ai/mcp
# MCP Server HTTP       mcp-server-http       [C#]      dotnet/ai/mcp
# MCP Server HTTP Auth  mcp-server-http-auth  [C#]      dotnet/ai/mcp
# MCP Server Hybrid     mcp-server-hybrid     [C#]      dotnet/ai/mcp

提示

实际上，你会希望在模式之间切换，因此我建议使用 mcp-server-hybrid 模板。它允许你以 Stdio 和 HTTP 两种模式运行服务。

验证输出：

dotnet new mcp-server -o MyAwesomeMCPServer -n MyAwesomeMCPServer --dry-run
# File actions would have been taken:
#   Create: MyAwesomeMCPServer\.vscode\launch.json
#   Create: MyAwesomeMCPServer\MyAwesomeMCPServer.csproj
#   Create: MyAwesomeMCPServer\Program.cs
#   Create: MyAwesomeMCPServer\Properties\launchSettings.json
#   Create: MyAwesomeMCPServer\README.md
#   Create: MyAwesomeMCPServer\appsettings.Development.json
#   Create: MyAwesomeMCPServer\appsettings.json

从模板创建：

dotnet new mcp-server -o MyAwesomeMCPServer -n MyAwesomeMCPServer

以下是 Program.cs 的内容：

using Microsoft.Extensions.Hosting;

var builder = Host.CreateApplicationBuilder(args);
builder.Services
    .AddMcpServer()
    .WithStdioServerTransport()
    .WithToolsFromAssembly();

await builder.Build().RunAsync();

[McpServerToolType]
public static class EchoTool
{
    [McpServerTool, Description("Echoes the message back to the client.")]
    public static string Echo(string message) => $"hello {message}";
}

这是一个简单的回声服务，它监听传入的消息并回复问候语。你可以通过创建带有 [McpServerTool] 特性的其他方法来添加更多工具。WithToolsFromAssembly() 方法会自动注册程序集中的所有工具。

本地运行

在项目目录中构建：

dotnet build -o Artefacts -c Release

运行 inspector：

npx @modelcontextprotocol/inspector -e DOTNET_ENVIRONMENT=Production dotnet "$(PWD)/Artefacts/MyAwesomeMCPServer.dll"

在浏览器中打开 inspector 并测试服务：

作为 .NET 工具分发

在项目目录中打包：

dotnet pack -o Artefacts -c Release

全局安装该工具：

dotnet tool install --global --add-source ./Artefacts MyAwesomeMCPServer

现在，在你全局安装此工具后，就可以在系统中的任何位置运行它。该工具将在你的终端中以 MyAwesomeMCPServer（或 myawesomemcpserver）的形式提供。

💡 你也可以创建本地工具清单，并在本地将 MCP 作为工具安装。

运行 inspector：

npx @modelcontextprotocol/inspector -e DOTNET_ENVIRONMENT=Production myawesomemcpserver

使用 Aspire 运行

在 Stdio 模式下

在 AppHost/Program.cs 中：

var builder = DistributedApplication.CreateBuilder(args);

builder.AddMCPInspector().WithStdio<Projects.MCPServer>();

builder.Build().Run();

在 HTTP 模式下

在 AppHost/Program.cs 中：

var builder = DistributedApplication.CreateBuilder(args);

var mcp = builder.AddProject<Projects.MCPServerRemote>("server");
builder.AddMCPInspector().WithMcp(mcp);

builder.Build().Run();

参考

• https://learn.microsoft.com/en-us/dotnet/core/tools/custom-templates
• https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools