@deskcreate/agentcraft
    Preparing search index...

    Interface AgentSkill

    interface AgentSkill {
        declaredToolNames?: string[];
        dependsOn?: (AdapterRef | AdapterRef[])[];
        description: string;
        directive?: string;
        metadata?: {
            auth?:
                | "none"
                | "custom"
                | "api-key"
                | "oauth"
                | "aws"
                | "connection-string";
            kind?: "custom"
            | "placeholder"
            | "mcp-backed"
            | "native-sdk";
            readOnly?: boolean;
            requiredSecrets?: string[];
            scopes?: string[];
            sideEffects?: ("none" | "read" | "write" | "external")[];
            trustLevel?: "trusted" | "review-required" | "untrusted";
        };
        name: string;
        requires: ("audio" | "tools" | "video" | "files" | "vision")[];
        skillMetadata?: SkillMetadata;
        systemPromptExtension?: string | (() => string);
        type: "skill";
        cleanup?(): Promise<void>;
        getTools?(): ToolDefinition[] | Promise<ToolDefinition[]>;
        init?(): Promise<void>;
        onAfterRun?(
            response: AgentResponse,
        ): AgentResponse | Promise<AgentResponse>;
        onAfterStream?(
            chunks: StreamChunk[],
            response: AgentResponse,
        ): AgentResponse | Promise<AgentResponse>;
        onBeforeRun?(
            params: AgentRunParams,
        ): AgentRunParams | Promise<AgentRunParams>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    declaredToolNames? dependsOn? description directive? metadata? name requires skillMetadata? systemPromptExtension? type

    Methods

    cleanup? getTools? init? onAfterRun? onAfterStream? onBeforeRun?

    Properties

    declaredToolNames?: string[]
    dependsOn?: (AdapterRef | AdapterRef[])[]
    description: string
    directive?: string
    metadata?: {
        auth?:
            | "none"
            | "custom"
            | "api-key"
            | "oauth"
            | "aws"
            | "connection-string";
        kind?: "custom"
        | "placeholder"
        | "mcp-backed"
        | "native-sdk";
        readOnly?: boolean;
        requiredSecrets?: string[];
        scopes?: string[];
        sideEffects?: ("none" | "read" | "write" | "external")[];
        trustLevel?: "trusted" | "review-required" | "untrusted";
    }
    name: string
    requires: ("audio" | "tools" | "video" | "files" | "vision")[]
    skillMetadata?: SkillMetadata
    systemPromptExtension?: string | (() => string)
    type: "skill"

    Methods

    • Returns Promise<void>

    • Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods