SharpMCP.Core 1.0.0

SharpMCP

<div align="center">

A modern .NET framework for building Model Context Protocol (MCP) servers

Getting Started • Documentation • Examples • Contributing

</div>

Overview

SharpMCP is a comprehensive framework that simplifies the creation of MCP servers in C#/.NET. It provides a robust foundation with abstractions, utilities, and common implementations that allow developers to focus on their specific use cases rather than protocol implementation details.

What is MCP?

The Model Context Protocol (MCP) is an open protocol that enables secure, controlled interactions between AI applications and external data sources or tools. MCP servers act as bridges between AI models and your systems, providing structured access to information and capabilities.

Features

• 🚀 Easy to Use - Simple, intuitive APIs with sensible defaults
• 🛠️ Flexible Architecture - Extensible design supporting custom tools and transports
• 📦 Batteries Included - Common tool implementations and patterns out of the box
• 🧪 Testing Support - Built-in testing harness and utilities
• 📚 Well Documented - Comprehensive documentation and examples
• ⚡ High Performance - Optimized for efficiency with async/await throughout
• 🔒 Secure by Default - Built-in security features and best practices

Getting Started

Prerequisites

• .NET 9.0 or later
• Visual Studio 2022, VS Code, or your preferred IDE

Quick Start

1. Install the SharpMCP packages

dotnet add package SharpMCP.Core
dotnet add package SharpMCP.Server

2. Create a simple MCP server

using SharpMCP;
using SharpMCP.Server;

// Define a simple tool
[McpTool("hello", "Says hello to someone")]
public class HelloTool : McpToolBase<HelloArgs>
{
    protected override Task<ToolResponse> ExecuteAsync(HelloArgs args, CancellationToken ct)
    {
        return Task.FromResult(new ToolResponse
        {
            Content = $"Hello, {args.Name}!"
        });
    }
}

public class HelloArgs
{
    [JsonRequired]
    [JsonDescription("Name of the person to greet")]
    public string Name { get; set; } = "";
}

// Create and run the server
class Program
{
    static async Task Main(string[] args)
    {
        var server = new McpServerBuilder()
            .WithName("HelloServer")
            .WithVersion("1.0.0")
            .AddTool<HelloTool>()
            .Build();

        await server.RunAsync();
    }
}

3. Run your server

dotnet run

Using Project Templates

For the fastest start, use our project templates:

# Install templates
dotnet new install SharpMCP.Templates

# Create a new MCP server project
dotnet new mcpserver -n MyAwesomeServer

# Create a new tool
cd MyAwesomeServer
dotnet new mcptool -n MyCustomTool

Architecture

SharpMCP follows a modular architecture:

┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
│   Your Tools    │     │   Your Server   │     │    Transport    │
│                 │────▶│                 │────▶│    (stdio)      │
│ - Custom Logic  │     │ - Configuration │     │                 │
└─────────────────┘     └─────────────────┘     └─────────────────┘
         │                       │                        │
         ▼                       ▼                        ▼
┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
│ SharpMCP.Tools  │     │ SharpMCP.Server │     │  SharpMCP.Core  │
│                 │     │                 │     │                 │
│ - Base Classes  │     │ - Server Base   │     │ - Interfaces    │
│ - Common Tools  │     │ - DI Support    │     │ - Protocol      │
└─────────────────┘     └─────────────────┘     └─────────────────┘

Examples

Check out the examples directory for complete working examples:

• FileSystemServer - Secure file system access
• DatabaseServer - SQL database operations (Coming Soon)
• ApiGatewayServer - REST API integration (Coming Soon)

Documentation

• Getting Started Guide
• Creating Tools
• Configuration
• Testing
• Security Best Practices
• API Reference

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

# Clone the repository
git clone https://github.com/leandrobueno/SharpMCP.git
cd SharpMCP

# Build the solution
dotnet build

# Run tests
dotnet test

# Pack NuGet packages locally
dotnet pack -o ./artifacts

Areas for Contribution

• 🐛 Bug fixes and improvements
• 📝 Documentation enhancements
• 🧪 Additional test coverage
• 🛠️ New tool implementations
• 🚀 Performance optimizations
• 💡 Feature suggestions

Roadmap

See our detailed roadmap for planned features and milestones.

Upcoming Features

• ✅ Core server infrastructure (v1.0)
• 🔄 Middleware pipeline system (v1.1)
• 🔄 Additional transport protocols (v1.2)
• 📅 Advanced monitoring and telemetry (v2.0)

Community

• GitHub Discussions - Ask questions and share ideas
• Issues - Report bugs or request features
• Discord - Join our community chat (Coming Soon)

License

SharpMCP is licensed under the MIT License.

Development Status

Completed Components

• ✅ Core abstractions and interfaces (SharpMCP.Core)
• ✅ Protocol layer with JSON-RPC support
• ✅ Tool system interfaces and attributes
• ✅ JSON Schema attribute system
• ✅ Transport abstractions
• ✅ Server interfaces and builder pattern
• ✅ Utility classes and response builders

In Progress

• 🔄 Server implementation (SharpMCP.Server)
• 🔄 StdioTransport implementation
• 🔄 Schema generation from C# types

Acknowledgments

• The Model Context Protocol team for creating MCP
• The .NET community for continuous support and feedback
• All our contributors and users

<div align="center"> Made with ❤️ by the SharpMCP Community </div>