SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface Reference<A, R>

    A capability that reads the INSTALL rather than a workbook — the API reference.

    A separate shape rather than a Descriptor with an ignored argument, because what a surface wraps around a descriptor is exactly the part that does not apply: naming a workbook on a terminal, routing to a session over MCP. A reference answers the same with no workbook open and no session created, and a surface that demanded either would be asking for something the capability never reads.

    Everything else holds as it does for a descriptor: defined once, adapted mechanically, text agent-facing and English, defaults applied by the tool.

    interface Reference<A = any, R = any> {
        description: string;
        name: string;
        params: readonly Param[];
        render(result: R, options?: RenderOptions): string;
        run(args: A): Promise<R>;
    }

    Type Parameters

    • A = any
    • R = any
    Index
    description: string

    One or two lines, agent-facing, English.

    name: string

    Tool name and subcommand — the same word on every surface.

    params: readonly Param[]
    • The default agent-facing rendering of a result.

      Parameters

      Returns string

    • Parameters

      • args: A

      Returns Promise<R>