AgentClassSkill<TSelf> Class

Definition

public abstract class AgentClassSkill<TSelf> : Microsoft.Agents.AI.AgentSkill where TSelf : AgentClassSkill<TSelf>

type AgentClassSkill<'Self (requires 'Self :> AgentClassSkill<'Self>)> = class
    inherit AgentSkill

Public MustInherit Class AgentClassSkill(Of TSelf)
Inherits AgentSkill

Type Parameters

Inheritance

Object

AgentSkill

AgentClassSkill<TSelf>

Examples

// Attribute-based approach (recommended, AOT-compatible):
public class PdfFormatterSkill : AgentClassSkill<PdfFormatterSkill>
{
    public override AgentSkillFrontmatter Frontmatter { get; } = new("pdf-formatter", "Format documents as PDF.");
    protected override string Instructions => "Use this skill to format documents...";

    [AgentSkillResource("template")]
    public string Template => "Use this template...";

    [AgentSkillScript("format-pdf")]
    private static string FormatPdf(string content) => content;
}

// Explicit override approach (AOT-compatible):
public class ExplicitPdfFormatterSkill : AgentClassSkill<ExplicitPdfFormatterSkill>
{
    private IReadOnlyList<AgentSkillResource>? _resources;
    private IReadOnlyList<AgentSkillScript>? _scripts;

    public override AgentSkillFrontmatter Frontmatter { get; } = new("pdf-formatter", "Format documents as PDF.");
    protected override string Instructions => "Use this skill to format documents...";

    public override IReadOnlyList<AgentSkillResource>? Resources => this._resources ??=
    [
        CreateResource("template", "Use this template..."),
    ];

    public override IReadOnlyList<AgentSkillScript>? Scripts => this._scripts ??=
    [
        CreateScript("format-pdf", FormatPdf),
    ];

    private static string FormatPdf(string content) => content;
}

Remarks

Inherit from this class to create a self-contained skill definition. Override the abstract properties to provide name, description, and instructions.

Scripts and resources can be defined in two ways:

• Attribute-based (recommended): Annotate methods with AgentSkillScriptAttribute to define scripts, and properties or methods with AgentSkillResourceAttribute to define resources. These are automatically discovered via reflection on TSelf. This approach is compatible with Native AOT.
• Explicit override: Override Resources and Scripts, using CreateResource(String, Object, String), CreateResource(String, Delegate, String, JsonSerializerOptions), and CreateScript(String, Delegate, String, JsonSerializerOptions) to define inline resources and scripts. This approach is also compatible with Native AOT.

Multi-level inheritance limitation: Discovery reflects only on TSelf, so if a further-derived subclass adds new attributed members, they will not be discovered unless that subclass also uses the CRTP pattern (e.g., class SpecialSkill : AgentClassSkill<SpecialSkill>).