Mcpsharp

🚀 MCPSharp

MCPSharp 是一个 .NET 库，用于构建符合 Model Context Protocol (MCP) 标准的服务器和客户端。该库能简化与 AI 模型的交互，支持工具注册、资源管理，还可与 Microsoft.Extensions.AI 和 Semantic Kernel 集成。

✨ 主要特性

• 与 Microsoft.Extensions.AI 集成：可将 MCP 服务器无缝连接到任何 IChatClient 实现。
• 对 Semantic Kernel 支持：通过简单注解就能把 Semantic Kernel 方法注册为 MCP 工具。
• 动态工具注册：支持在运行时添加和管理工具，增强了系统的灵活性。
• 资源通知机制：提供资源变化的通知功能，提升了系统的实时响应能力。

📦 安装指南

文档未提供安装步骤，此部分跳过。

💻 使用示例

基础用法

工具注册

using Microsoft.SemanticKernel;

public class MySkillClass
{
    [KernelFunction("MyFunction")]
    public string MyFunction(string input) => $"Processed: {input}";
}

// MCP 服务器注册Semantic Kernel 类
MCPServer.Register<MySkillClass>();

客户端调用

var client = new MCPClient("MyClient", "1.0", "http://localhost:5000");
var result = await client.CallToolAsync("MyFunction", new Dictionary<string, object> { {"input", "test"} });

高级用法

XML 文档支持

/// <summary>
/// 提供数学运算功能
/// </summary>
public class Calculator
{
    /// <summary>
    /// 将两个数字相加。
    /// </summary>
    /// <param name="a">要相加的第一个数字。</param>
    /// <param name="b">要相加的第二个数字。</param>
    /// <returns>两个数字的和。</returns>
    [McpTool]
    public static int Add(
        [McpParameter(true)] int a,
        [McpParameter(true)] int b)
    {
        return a + b;
    }
}

📚 详细文档

使用场景

• 当你需要快速搭建一个与 AI 模型交互的系统时。
• 你的项目需要与 Microsoft.Extensions.AI 集成时。
• 你希望利用 Semantic Kernel 的强大功能来扩展 MCP 功能时。
• 你需要在运行时动态添加或管理工具和资源时。

API 参考

属性

方法

• MCPServer.StartAsync(string serverName, string version)：启动 MCP 服务器。
• MCPServer.Register()：注册一个包含工具或资源的类。
• MCPServer.AddToolHandler(Tool tool, Delegate func)：动态添加工具处理程序。

迁移注意事项

⚠️ 重要提示

• [McpFunction] 已弃用，建议使用 [McpTool] 替代。
• 旧的 MCPServer.RegisterTool<T>() 方法已弃用，推荐使用新的 MCPServer.Register<T>()。

🔧 技术细节

文档未提供技术实现细节，此部分跳过。

🤝 贡献指南

我们欢迎任何贡献！请随意提交 Pull Request 或提出问题。

📄 许可证

MCPSharp 项目采用 MIT 许可证。