.NET环境下Model Context Protocol (MCP) C SDK的安装与配置指南

.NET环境下Model Context Protocol (MCP) C# SDK的安装与配置指南

csharp-sdk The official C# SDK for Model Context Protocol servers and clients, maintained by Microsoft 项目地址: https://gitcode.com/gh_mirrors/csha/csharp-sdk

1. 项目基础介绍

Model Context Protocol (MCP) C# SDK 是一个开源项目，旨在为 .NET 应用程序、服务和库提供一个官方的 C# 软件开发工具包（SDK），以便它们能够实现与 MCP 客户端和服务器之间的交互。MCP 是一个开放协议，用于标准化应用程序向大型语言模型（LLMs）提供上下文的方式。

该项目主要使用 C# 编程语言，并且是为 .NET 环境设计的。

2. 项目使用的关键技术和框架

• Model Context Protocol (MCP): 该项目基于 MCP 协议，该协议定义了客户端和服务器如何通信以及如何向 LLMs 提供上下文。
• .NET: SDK 是为 .NET 平台构建的，因此使用了 .NET 的各种特性和库。
• 依赖注入 (Dependency Injection): 用于在项目中管理依赖关系。
• 异步编程 (Async/Await): 用于非阻塞调用和改善性能。
• JSON 序列化/反序列化: 用于处理 MCP 协议中的数据交换。

3. 项目安装和配置的准备工作及详细安装步骤

准备工作

在开始安装之前，请确保您的开发环境满足以下要求：

• 安装了 .NET SDK。
• 有一个支持 .NET 的 IDE 或编辑器，例如 Visual Studio 或 Visual Studio Code。

安装步骤

步骤 1: 克隆或下载项目

首先，您需要从 GitHub 下载或克隆项目：

git clone https://github.com/modelcontextprotocol/csharp-sdk.git

或者，如果您不想使用 Git 命令行工具，可以从 GitHub 项目页面下载 ZIP 文件并解压缩到您的本地环境。

步骤 2: 安装 NuGet 包

在项目目录中，打开命令提示符或终端，然后运行以下命令来安装必要的 NuGet 包：

dotnet add package ModelContextProtocol --prerelease

--prerelease 参数是必需的，因为该项目可能包含了预发布版本的包。

步骤 3: 创建和配置项目

如果您打算在 Visual Studio 或 Visual Studio Code 中工作，可以创建一个新的 .NET 项目，并将 SDK 添加为项目引用。或者，如果直接在项目目录中工作，确保有 ModelContextProtocol.sln 解决方案文件，并且已经安装了所有必要的 NuGet 包。

步骤 4: 编写示例代码

在您的项目中，您可以开始使用 MCP SDK 编写代码。以下是一个简单的示例，演示如何创建一个 MCP 客户端并调用一个工具：

var client = await McpClientFactory.CreateAsync(new McpClientSettings
{
    Id = "everything",
    Name = "Everything",
    TransportType = TransportTypes.StdIo,
    TransportOptions = new Dictionary<string, object?>
    {
        ["command"] = "npx",
        ["arguments"] = "-y @modelcontextprotocol/server-everything"
    }
});

foreach (var tool in await client.ListToolsAsync())
{
    Console.WriteLine($"{tool.Name} ({tool.Description})");
}

var result = await client.CallToolAsync("echo", new Dictionary<string, object?>
{
    ["message"] = "Hello MCP!"
}, CancellationToken.None);

Console.WriteLine(result.Content.First(c => c.Type == "text").Text);

请确保将示例代码中的 "npx -y @modelcontextprotocol/server-everything" 替换为实际的 MCP 服务器命令。

以上步骤应该能够帮助您在 .NET 环境中成功安装和配置 MCP C# SDK。

csharp-sdk The official C# SDK for Model Context Protocol servers and clients, maintained by Microsoft 项目地址: https://gitcode.com/gh_mirrors/csha/csharp-sdk