Action Definition

interface ActionDefinition {
    name: string
    description: string
    options?: Record<string, ActionOption>
    approvalRequired?: boolean
}

interface ActionOption {
    type: "string" | "number" | "boolean"
    description?: string
    required?: boolean
}

interface ToolAction {
    name: string
    options?: Record<string, unknown>
}

{
    name: "refresh",
    description: "Refresh the current view",
}

{
    name: "createProject",
    description: "Create a new project with a name and optional description",
    options: {
        name: {
            type: "string",
            description: "Project name",
            required: true,
        },
        description: {
            type: "string",
            description: "Project description",
            required: false,
        },
    },
}

{
    name: "deleteProject",
    description: "Permanently delete a project and all its data",
    options: {
        projectId: {
            type: "string",
            description: "ID of the project to delete",
            required: true,
        },
    },
    approvalRequired: true,
}

{
    name: "toggleNotifications",
    description: "Enable or disable notifications",
    options: {
        enabled: {
            type: "boolean",
            description: "Whether notifications are enabled",
            required: true,
        },
    },
}

{
    name: "setQuantity",
    description: "Set the quantity for an item",
    options: {
        itemId: {
            type: "string",
            required: true,
        },
        quantity: {
            type: "number",
            description: "New quantity (must be positive)",
            required: true,
        },
    },
}

// Good
description: "Archive a project. The project will be hidden from the active list but can be restored later."

// Bad
description: "Archive"

// Good
name: "createProject"
name: "deleteUser"
name: "toggleDarkMode"

// Bad
name: "project"
name: "doDelete"
name: "darkMode"

// Should require approval
{ name: "deleteAccount", approvalRequired: true }
{ name: "sendEmail", approvalRequired: true }
{ name: "publishPost", approvalRequired: true }

// Usually don't need approval
{ name: "createDraft", approvalRequired: false }
{ name: "updateSettings", approvalRequired: false }
{ name: "search", approvalRequired: false }