Getting Started
Prerequisites
- .NET 10 SDK or later
Installation
Add the Core package to your project:
dotnet add package ZampaStudio.CleanFramework.Core
Basic Usage
Implement the IService<TRequest, TResponse> interface:
using ZampaStudio.CleanFramework.Core;
public class MyService : IService<MyRequest, MyResponse>
{
public Task<MyResponse> ExecuteAsync(
MyRequest request,
CancellationToken cancellationToken = default)
{
// Your logic here
return Task.FromResult(new MyResponse());
}
}
Project Structure
The template follows Microsoft .NET library conventions:
| Project | Role | Description |
|---|---|---|
*.Core |
Required | Core library — all public abstractions and interfaces |
*.McpServer |
Recommended | MCP server exposing Core functionality |
*.Core.Tests |
Required | Unit tests for Core |
New library functionality goes into the Core project. Additional projects can be added for distinct concerns (e.g., *.Abstractions, *.Extensions, *.Serialization) but Core remains the primary package consumers depend on.
MCP Server (Recommended)
The template includes a recommended MCP server that exposes Core functionality as tools for AI agents.
Install the MCP server tool:
dotnet tool install --global ZampaStudio.CleanFramework.McpServer
Run it:
cleanframework-mcp