Mcpsharp

🚀 MCPSharp

MCPSharp is a .NET library for building servers and clients that comply with the Model Context Protocol (MCP). This library aims to simplify interactions with AI models, supporting tool registration, resource management, and integration with Microsoft.Extensions.AI and Semantic Kernel.

🚀 Quick Start

Example Code

Tool Registration

using Microsoft.SemanticKernel;

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

// MCP server registers Semantic Kernel class
MCPServer.Register<MySkillClass>();

Client Call

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

✨ Features

• Integration with Microsoft.Extensions.AI: Allows seamless connection of MCP servers to any IChatClient implementation.
• Support for Semantic Kernel: Enables registration of Semantic Kernel methods as MCP tools with simple annotations.
• Dynamic Tool Registration: Supports adding and managing tools at runtime, enhancing flexibility.
• Resource Notification Mechanism: Provides notification functionality for resource changes, improving the system's real - time response capability.

💻 Usage Examples

Basic Usage

This library is suitable for the following scenarios:

• When you need to quickly build a system for interacting with AI models.
• When your project requires integration with Microsoft.Extensions.AI.
• When you want to leverage the powerful features of Semantic Kernel to extend MCP functionality.
• When you need to dynamically add or manage tools and resources at runtime.

📚 Documentation

API Reference

Attributes

• [McpTool]: Marks a class or method as an MCP tool.

  • Optional parameters:
    • Name: Tool name (default: class/method name).
    • Description: Tool description.

• [McpParameter]: Provides metadata for function parameters.

  • Optional parameters:
    • Description: Parameter description.
    • Required: Whether it is a required parameter (default: false).

Methods

• MCPServer.StartAsync(string serverName, string version): Starts the MCP server.
• MCPServer.Register(): Registers a class containing tools or resources.
• MCPServer.AddToolHandler(Tool tool, Delegate func): Dynamically adds a tool handler.

XML Documentation Support

MCPSharp automatically extracts documentation information from XML comments, allowing you to quickly modify tool names and descriptions without recompilation.

/// <summary>
/// Provides mathematical operation functions
/// </summary>
public class Calculator
{
    /// <summary>
    /// Adds two numbers.
    /// </summary>
    /// <param name="a">The first number to add.</param>
    /// <param name="b">The second number to add.</param>
    /// <returns>The sum of the two numbers.</returns>
    [McpTool]
    public static int Add(
        [McpParameter(true)] int a,
        [McpParameter(true)] int b)
    {
        return a + b;
    }
}

Migration Notes

• [McpFunction] is deprecated. It is recommended to use [McpTool] instead.
• The old MCPServer.RegisterTool<T>() method is deprecated. It is recommended to use the new MCPServer.Register<T>().

Contribution Guidelines

We welcome any contributions! Please feel free to submit a Pull Request or raise an issue.

📄 License

The MCPSharp project is licensed under the MIT license.