.NET SDK Guide

Use the schemabound-dotnet package when you want to integrate SCHEMABOUND into .NET services, enterprise applications, and platform components with a typed client experience that fits naturally into the broader .NET ecosystem.

Why Choose The .NET SDK

• Integrate SCHEMABOUND into ASP.NET, worker services, and internal platform components.
• Build strongly typed service-to-service integrations on a familiar .NET foundation.
• Adopt SCHEMABOUND in production applications without dropping to lower-level protocol work unless you need it.

Installation

dotnet add package Schemabound.Dotnet

Or via NuGet:

Install-Package Schemabound.Dotnet

What You Get

The .NET SDK gives you:

1. A typed .NET integration surface for embedding SCHEMABOUND into application and platform code.
2. Interop over the public runtime model so .NET services stay aligned with the supported SCHEMABOUND contract.
3. Utilities and examples that help teams wire SCHEMABOUND into real service and enterprise deployment patterns.

Quick Start

using Schemabound;

var engine = new ReflectionEngine();
var server = new GrpcServer();

await server.RunAsync();

This is the fastest way to stand up a .NET integration, validate the client path, and start wiring SCHEMABOUND into a service or application workflow.

Runtime Augmentation

SCHEMABOUND runtime calls can carry runtime-augmentation selection metadata so your .NET application can attach stable business and request context before validation or execution.

Use the public runtime headers when you need SCHEMABOUND behavior to reflect application identity, tool intent, tenant boundaries, or domain-specific routing context.

The key runtime headers are:

• x-schemabound-runtime-augmentation-id to reference a specific augmentation identifier
• x-schemabound-runtime-augmentation-key to reference a stable augmentation key
• x-schemabound-tool-name, x-schemabound-tool-intent, x-schemabound-user-id, x-schemabound-organization-id, x-schemabound-domain-tags, and x-schemabound-table-names to provide matching context

SCHEMABOUND emits resolved augmentation identity into normal query events, while sensitive rendered content remains reserved for dedicated audit handling.

Suggested Starting Points

• Shipping a typed platform or product integration on .NET: start here.
• Embedding SCHEMABOUND into an ASP.NET or worker-service architecture: start here.
• Passing application context into SCHEMABOUND execution paths: start with the runtime-augmentation headers above.

Contributing

For Rust Core Changes

If you need to change the shared public runtime or core SCHEMABOUND behavior:

1. File an issue in schemabound-public
2. Submit a PR to schemabound-public (see Contribution Workflow)
3. Once merged and exported, the change flows to schemabound-dotnet automatically

For .NET Layer Improvements

To improve the .NET developer experience, add helpers, or expand documentation:

1. Fork schemabound-dotnet
2. Create a feature branch
3. Make changes in Schemabound/ (.NET layer only)
4. Submit PR to schemabound-dotnet/main
5. We’ll review and merge

Example:

// Add a utility class
// Schemabound/Config/ConfigLoader.cs

public static class ConfigLoader
{
    public static RoamConfig LoadFromFile(string path)
    {
        // Load configuration
    }
}

API Reference

See the full API docs for the .NET package surface, method signatures, and integration details.