SoulFire TypeScript SDK 2.10.3
    Preparing search index...
    ApiMethodDocs: Message<"soulfire.v1.ApiMethodDocs"> & {
        description: string;
        displayName: string;
        execution: string;
        exposeToMcp: boolean;
        mcpRequiresConfirmation: boolean;
        permissions: string[];
        preconditions: string[];
        scope: string;
        sideEffects: string[];
    }

    Type Declaration

    • description: string

      from field: string description = 2;

    • displayName: string

      from field: string display_name = 1;

    • execution: string

      from field: string execution = 6;

    • exposeToMcp: boolean

      Explicitly publishes a unary method as an MCP tool.

      from field: bool expose_to_mcp = 8;

    • mcpRequiresConfirmation: boolean

      Requires the MCP caller to pass confirm=true. Mandatory for exposed mutation and destructive methods.

      from field: bool mcp_requires_confirmation = 9;

    • permissions: string[]

      from field: repeated string permissions = 3;

    • preconditions: string[]

      from field: repeated string preconditions = 5;

    • scope: string

      from field: string scope = 4;

    • sideEffects: string[]

      from field: repeated string side_effects = 7;

    from message soulfire.v1.ApiMethodDocs