https://github.com/nanoframework/nanoframework.webserver
:package: Web server for nanoFramework packed with features: REST api using attributes, multithread requests, parameters in query URL, static files serving.
https://github.com/nanoframework/nanoframework.webserver
csharp dotnet esp32 nanoframework nxp rest rest-api restful-api restful-webservices stm32 webserver
Last synced: about 2 months ago
JSON representation
:package: Web server for nanoFramework packed with features: REST api using attributes, multithread requests, parameters in query URL, static files serving.
- Host: GitHub
- URL: https://github.com/nanoframework/nanoframework.webserver
- Owner: nanoframework
- License: mit
- Created: 2020-10-14T17:14:44.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T00:41:26.000Z (over 1 year ago)
- Last Synced: 2024-10-29T21:06:16.652Z (over 1 year ago)
- Topics: csharp, dotnet, esp32, nanoframework, nxp, rest, rest-api, restful-api, restful-webservices, stm32, webserver
- Language: C#
- Homepage: https://www.nanoframework.net
- Size: 655 KB
- Stars: 34
- Watchers: 6
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://sonarcloud.io/dashboard?id=nanoframework_lib-nanoframework.WebServer) [](https://sonarcloud.io/dashboard?id=nanoframework_lib-nanoframework.WebServer) [](https://www.nuget.org/packages/nanoFramework.WebServer/) [](https://github.com/nanoframework/Home/blob/main/CONTRIBUTING.md) [](https://discord.gg/gCyBu8T)
-----
# .NET nanoFramework WebServer with Model Context Protocol (MCP)
## Build status
| Component | Build Status | NuGet Package |
|:-|---|---|
| nanoFramework.WebServer | [](https://dev.azure.com/nanoframework/nanoFramework.WebServer/_build/latest?definitionId=65&repoName=nanoframework%2FnanoFramework.WebServer&branchName=main) | [](https://www.nuget.org/packages/nanoFramework.WebServer/) |
| nanoFramework.WebServer.FileSystem | [](https://dev.azure.com/nanoframework/nanoFramework.WebServer/_build/latest?definitionId=65&repoName=nanoframework%2FnanoFramework.WebServer&branchName=main) | [](https://www.nuget.org/packages/nanoFramework.WebServer.FileSystem/) |
| nanoFramework.WebServer.Mcp | [](https://dev.azure.com/nanoframework/nanoFramework.WebServer/_build/latest?definitionId=65&repoName=nanoframework%2FnanoFramework.WebServer&branchName=main) | [](https://www.nuget.org/packages/nanoFramework.WebServer.Mcp/) |
## Overview
This library provides a lightweight, multi-threaded HTTP/HTTPS WebServer for .NET nanoFramework with comprehensive **Model Context Protocol (MCP)** support for AI agent integration.
### Key Features
- **Multi-threaded request handling**
- **Static file serving** with FileSystem support
- **RESTful API support** with parameter handling
- **Route-based controllers** with attribute decoration
- **Authentication support** (Basic, API Key)
- **HTTPS/SSL support** with certificates
- **Model Context Protocol (MCP)** for AI agent integration
- **Automatic tool discovery** and JSON-RPC 2.0 compliance
## Quick Start
### Basic Event Based WebServer
Using the Web Server is very straight forward and supports event based calls.
```csharp
// You need to be connected to a Wi-Fi or ethernet connection with a proper IP Address
// Optionally you can pass a parameter with the IP address for the server to bind to
using (WebServer server = new WebServer(80, HttpProtocol.Http))
{
server.CommandReceived += ServerCommandReceived;
server.Start();
Thread.Sleep(Timeout.Infinite);
}
private static void ServerCommandReceived(object source, WebServerEventArgs e)
{
if (e.Context.Request.RawUrl.ToLower() == "/hello")
{
WebServer.OutputAsStream(e.Context.Response, "Hello from nanoFramework!");
}
else
{
WebServer.OutputHttpCode(e.Context.Response, HttpStatusCode.NotFound);
}
}
```
### Controller-Based WebServer
Controllers are supported including with parametarized routes like 'api/led/{id}/dosomething/{order}'.
```csharp
using (WebServer server = new WebServer(80, HttpProtocol.Http, new Type[] { typeof(MyController) }))
{
server.Start();
Thread.Sleep(Timeout.Infinite);
}
public class MyController
{
[Route("api/hello")]
[Method("GET")]
public void Hello(WebServerEventArgs e)
{
WebServer.OutputAsStream(e.Context.Response, "Hello from Controller!");
}
[Route("api/led/{id}")]
[Method("GET")]
public void LedState(WebServerEventArgs e)
{
string ledId = e.GetRouteParameter("id");
WebServer.OutputAsStream(e.Context.Response, $"You selected Led {ledId}!");
}
}
```
## Model Context Protocol (MCP) Support
Enable AI agents to interact with your embedded devices through standardized tools and JSON-RPC 2.0 protocol.
### Defining MCP Tools
```csharp
public class IoTTools
{
[McpServerTool("read_sensor", "Reads temperature from sensor")]
public static string ReadTemperature()
{
// Your sensor reading code
return "23.5°C";
}
[McpServerTool("control_led", "Controls device LED", "Output the status of the LED")]
public static string ControlLed(LedCommand command)
{
// Your LED control code
return $"LED set to {command.State}";
}
}
public class LedCommand
{
public string State
{
[Description("LED state: on, off, or blink")]
get;
set;
}
}
```
### Defining MCP Prompts
You can define reusable, high-level prompts for AI agents using the `McpServerPrompt` attribute. Prompts encapsulate multi-step instructions or workflows that can be invoked by agents.
Here's a simple example:
```csharp
using nanoFramework.WebServer.Mcp;
public class McpPrompts
{
[McpServerPrompt("echo_sanity_check", "Echo test prompt")]
public static PromptMessage[] EchoSanityCheck()
{
return new PromptMessage[]
{
new PromptMessage("Call Echo with the string 'Hello MCP world!' and return the response.")
};
}
}
```
Prompts can be discovered and invoked by AI agents in the same way as tools. You can also define prompts with parameters using the `McpPromptParameter` attribute.
### Setting Up MCP Server
```csharp
public static void Main()
{
// Connect to WiFi first
var connected = WifiNetworkHelper.ConnectDhcp(Ssid, Password, requiresDateTime: true);
// Discover and register MCP tools
McpToolRegistry.DiscoverTools(new Type[] { typeof(IoTTools) });
// Discover and register MCP prompts
McpPromptRegistry.DiscoverPrompts(new Type[] { typeof(McpPrompts) });
// Start WebServer with MCP support
using (var server = new WebServer(80, HttpProtocol.Http, new Type[] { typeof(McpServerController) }))
{
// Optional customization
McpServerController.ServerName = "MyIoTDevice";
McpServerController.Instructions = "IoT device with sensor and LED control capabilities.";
server.Start();
Thread.Sleep(Timeout.Infinite);
}
}
```
### AI Agent Integration
Once running, AI agents can discover and invoke your tools:
```json
// Tool discovery
POST /mcp
{
"jsonrpc": "2.0",
"method": "tools/list",
"id": 1
}
// Tool invocation
POST /mcp
{
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"name": "control_led",
"arguments": {"State": "on"}
},
"id": 2
}
```
## Documentation
| Topic | Description |
|-------|-------------|
| [Controllers and Routing](./doc/controllers-routing.md) | Learn about route attributes, method decorations, and URL parameters |
| [Authentication](./doc/authentication.md) | Configure Basic Auth, API Key, and custom authentication |
| [HTTPS and Certificates](./doc/https-certificates.md) | Set up SSL/TLS encryption with certificates |
| [File System Support](./doc/file-system.md) | Serve static files from storage devices |
| [Model Context Protocol (MCP)](./doc/model-context-protocol.md) | Complete MCP guide for AI agent integration |
| [REST API Development](./doc/rest-api.md) | Build RESTful APIs with request/response handling |
| [Event-Driven Programming](./doc/event-driven.md) | Handle requests through events and status monitoring |
| [Examples and Samples](./doc/examples.md) | Working examples and code samples |
## Limitations
- No compression support in request/response streams
- MCP implementation supports server features only (no notifications or SSE)
- No or single parameter limitation for MCP tools (use complex objects for multiple parameters)
- Prompt parameters, when declared, are always mandatory.
## Installation
Install 'nanoFramework.WebServer' for the Web Server without File System support. Install 'nanoFramework.WebServer.FileSystem' for file serving, so with devices supporting File System.
Install 'nanoFramework.WebServer.Mcp' for MCP support. It does contains the full 'nanoFramework.WebServer' but does not include native file serving. You can add this feature fairly easilly by reusing the code function serving it.
## Contributing
For documentation, feedback, issues and contributions, please refer to the [Home repo](https://github.com/nanoframework/Home).
Join our Discord community [here](https://discord.gg/gCyBu8T).
## Credits
The list of contributors to this project can be found at [CONTRIBUTORS](https://github.com/nanoframework/Home/blob/main/CONTRIBUTORS.md).
## License
Licensed under the [MIT license](LICENSE.md).
## Code of Conduct
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behaviour in our community.
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
## .NET Foundation
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).