Zyntaxis.Promptr.Abstractions 1.0.1

# Zyntaxis.Promptr.Abstractions

Stable interfaces and DTOs for Promptr plugins. Keep your plugins decoupled from the host with a tiny, versioned contract.

- **Target**: .NET 8
- **Package**: `Zyntaxis.Promptr.Abstractions`
- **ABI policy**: `AssemblyVersion = 1.0.0.0` (pinned). We bump the NuGet `Version` for releases that don’t break ABI.

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

What’s inside

public interface IPromptrPlugin
{
    string Id { get; }
    string Purpose { get; }
    string Category { get; }          // e.g. "Support/Freshdesk"
    string[] Tags { get; }
    Version Version { get; }

    IEnumerable<ToolSpec> Tools();    // small specs only
    Task<InvokeResult> InvokeAsync(string toolName, JsonElement args, CancellationToken ct);
    string Manual();                  // human docs (not sent to model by default)
    void Initialize(IPluginContext ctx);
}

public interface IPluginContext
{
    ILogger Logger { get; }
    IHttpClientFactory Http { get; }
    ISecretProvider Secrets { get; }
    ICache Cache { get; }
    string DataDir { get; }
}

public sealed record ToolSpec(string Name, string Summary, string JsonSchema);
public sealed record InvokeResult(JsonElement Data, string? HumanSummary = null);

Minimal plugin skeleton

public sealed class MyPlugin : IPromptrPlugin
{
    private IPluginContext _ctx = default!;
    public string Id => "myplugin";
    public string Purpose => "Does a useful thing fast.";
    public string Category => "Utilities";
    public string[] Tags => new[] { "utils", "demo" };
    public Version Version => new(1,0,0);

    public void Initialize(IPluginContext ctx) => _ctx = ctx;

    public IEnumerable<ToolSpec> Tools() => new[]
    {
        new ToolSpec(
            "Ping",
            "Returns pong and the input text.",
            "{\"type\":\"object\",\"properties\":{\"text\":{\"type\":\"string\"}},\"required\":[\"text\"]}")
    };

    public async Task<InvokeResult> InvokeAsync(string toolName, JsonElement args, CancellationToken ct)
    {
        if (toolName != "Ping") throw new ArgumentOutOfRangeException(nameof(toolName));
        var text = args.GetProperty("text").GetString();
        var result = System.Text.Json.JsonSerializer.SerializeToElement(new { reply = $"pong: {text}" });
        return new InvokeResult(result, $"pong: {text}");
    }

    public string Manual() => "Tools:\n- Ping(text:string) → { reply:string }";
}

Host note

Make sure the host and plugins reference the same Abstractions package version to avoid type identity issues (your AssemblyLoadContext should resolve Abstractions to the host copy).

License

MIT

---