Interface AgentCapabilityDef<Name, Input, Output, Ctx, Principal>

A typed action that an authenticated agent transport may expose.

interface AgentCapabilityDef<
    Name extends string = string,
    Input extends AgentCapabilitySchema = AgentCapabilitySchema,
    Output extends AgentCapabilitySchema = AgentCapabilitySchema,
    Ctx = unknown,
    Principal = unknown,
> {
    description: string;
    handle: (
        args: {
            capability: AgentCapabilityDef<Name, Input, Output, Ctx, Principal>;
            ctx: Ctx;
            input: InferAgentCapabilitySchemaOutput<Input>;
            principal: Principal;
        },
    ) => MaybePromise<InferAgentCapabilitySchemaInput<Output>>;
    input: Input;
    kind: "agentCapability";
    name: Name;
    output: Output;
}

Type Parameters

Name extends string = string
Input extends AgentCapabilitySchema = AgentCapabilitySchema
Output extends AgentCapabilitySchema = AgentCapabilitySchema
Ctx = unknown
Principal = unknown

Index

Properties

description handle input kind name output

Properties

`Readonly`description

description: string

`Readonly`handle

handle: (
    args: {
        capability: AgentCapabilityDef<Name, Input, Output, Ctx, Principal>;
        ctx: Ctx;
        input: InferAgentCapabilitySchemaOutput<Input>;
        principal: Principal;
    },
) => MaybePromise<InferAgentCapabilitySchemaInput<Output>>

`Readonly`input

input: Input

`Readonly`kind

kind: "agentCapability"

`Readonly`name

name: Name

`Readonly`output

output: Output