Skip to content

Commit c00b00c

Browse files
committed
docs(README): add NuGet badge, link and install command
1 parent c9efb5b commit c00b00c

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ModelContextProtocol.NET
22

3+
![NuGet Version](https://img.shields.io/nuget/vpre/ModelContextProtocol.NET.Server)
4+
35
A C# SDK implementation of the Model Context Protocol (MCP), enabling seamless integration between AI models and development environments.
46

57
## Overview
@@ -9,12 +11,14 @@ ModelContextProtocol.NET is a native .NET implementation of the Model Context Pr
911
## Features
1012

1113
### Ready to Use
14+
1215
- ✅ Standard I/O Communication
1316
- ✅ Tool Integration Framework
1417
- ✅ Native AOT Compatible
1518
- ✅ Calculator Demo Implementation
1619

1720
### Under Development
21+
1822
- 🚧 WebSocket Support
1923
- 🚧 Resource Management
2024
- 🚧 Prompt System
@@ -26,19 +30,29 @@ The repository includes a fully functional calculator demo that showcases the ba
2630
## Technical Details
2731

2832
### Architecture
33+
2934
The project is structured into multiple components:
35+
3036
- **Core Library**: Contains the fundamental protocol implementation
3137
- **Server Components**: Handles communication and request processing
3238
- **Demo Implementation**: Provides a working example with a calculator application
3339

3440
### Key Benefits
41+
3542
- **Native AOT Support**: Fully compatible with .NET Native AOT compilation for optimal performance
3643
- **Modular Design**: Clean separation of concerns allowing for flexible implementation
3744
- **Standard Compliance**: Implements the Model Context Protocol specification
3845

3946
## Getting Started
4047

41-
The easiest way to get started is to look at the calculator demo in `src/ModelContextProtocol.NET.Demo.Calculator`. Here's a quick example of how to set up an MCP server:
48+
Install [the server package](https://www.nuget.org/packages/ModelContextProtocol.NET.Server):
49+
50+
```bash
51+
dotnet add package ModelContextProtocol.NET.Server
52+
```
53+
54+
The easiest way to get started is to look at the calculator demo in `src/ModelContextProtocol.NET.Demo.Calculator`.
55+
Here's a quick example of how to set up an MCP server:
4256

4357
```csharp
4458
// Create server info
@@ -88,6 +102,7 @@ public enum CalculatorOperation { Add, Subtract, Multiply, Divide }
88102
```
89103

90104
Check out the complete calculator demo for a full working example including:
105+
91106
- Tool handler implementation
92107
- Request/response handling
93108
- Error management

0 commit comments

Comments
 (0)