Zyntaxis.Promptr.SDK 1.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Zyntaxis.Promptr.SDK --version 1.0.1
                    


                    

                
NuGet\Install-Package Zyntaxis.Promptr.SDK -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Zyntaxis.Promptr.SDK" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Zyntaxis.Promptr.SDK" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Zyntaxis.Promptr.SDK" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Zyntaxis.Promptr.SDK --version 1.0.1
                    


                    

                
#r "nuget: Zyntaxis.Promptr.SDK, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Zyntaxis.Promptr.SDK@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Zyntaxis.Promptr.SDK&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Zyntaxis.Promptr.SDK&version=1.0.1
                    


                            Install as a Cake Tool
                        

                    

                
# Zyntaxis.Promptr.SDK

Tiny helpers for building Promptr plugins: compact JSON schemas, strict arg parsing, and simple result creation.

- **Target**: .NET 8
- **Depends on**: `Zyntaxis.Promptr.Abstractions`
- **No external packages**

## Install
```bash
dotnet add package Zyntaxis.Promptr.SDK --version 1.0.1

What you get

1) JsonSchemas – build tiny tool schemas

Keep tool specs short to save tokens.

using Promptr.SDK;

var schema = JsonSchemas.Obj(
  props: "\"cityName\":" + JsonSchemas.Str() + ",\"limit\":" + JsonSchemas.Int(1,50),
  requiredCsv: "cityName"
);
// => {"type":"object","properties":{"cityName":{"type":"string"},"limit":{"type":"integer","minimum":1,"maximum":50}},"required":["cityName"]}

2) ArgReader – strict, friendly arg binding

var a = new ArgReader(argsJsonElement);
var city  = a.RequiredString("cityName");
var limit = a.OptionalInt("limit", 10);

3) Result.From – serialize objects to InvokeResult

return Result.From(
  new { tempC = 29.8, summary = "Partly cloudy" },
  human: "29.8 °C, partly cloudy"
);

Example: a clean tool

public IEnumerable<ToolSpec> Tools() => new[]
{
    new ToolSpec(
        "GetWeatherInCity",
        "Current weather for a city by name.",
        JsonSchemas.Obj("\"cityName\":" + JsonSchemas.Str(), "cityName"))
};

public async Task<InvokeResult> InvokeAsync(string tool, JsonElement args, CancellationToken ct)
{
    if (tool != "GetWeatherInCity") throw new ArgumentOutOfRangeException(nameof(tool));
    var a = new ArgReader(args);
    var city = a.RequiredString("cityName");

    // call your provider...
    var data = new { city, tempC = 30.2, summary = "Partly cloudy" };
    return Result.From(data, $"{data.tempC} °C, {data.summary}");
}

Versioning

  • Matches Zyntaxis.Promptr.Abstractions minor versions.
  • Safe to update within the same AssemblyVersion (1.0.0.0).

License

MIT

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 331 11/12/2025