@archastro/sdk
    Preparing search index...

    Interface AgentHealthAction

    A single actionable item in an agent's health or setup checklist, carrying the structured data needed to render the item and deep-link to the resolution flow.

    interface AgentHealthAction {
        agent?: string;
        app?: string;
        created_at?: string;
        depends_on?: string[];
        description?: string;
        id: string;
        kind: string;
        last_verified_at?: string;
        last_verifier_message?: string;
        org?: string;
        params?: Record<string, unknown>;
        required: boolean;
        sort_order: number;
        source: string;
        status: string;
        title: string;
        updated_at?: string;
        verify_config?: Record<string, unknown>;
    }
    Index

    Properties

    agent? app? created_at? depends_on? description? id kind last_verified_at? last_verifier_message? org? params? required sort_order source status title updated_at? verify_config?

    Properties

    agent?: string

    ID of the agent this action is scoped to (agt_...). null for org-level actions.

    app?: string

    ID of the application this action is associated with (app_...). null when not app-scoped.

    created_at?: string

    When this health action was first created (ISO 8601).

    depends_on?: string[]

    IDs of other health actions that must reach "completed" status before this action can be started. Empty array when there are no dependencies.

    description?: string

    Longer Markdown-formatted explanation of what the action requires and why. null if not provided.

    id: string

    Health action ID (aha_...).

    kind: string

    Category of action to take. One of "env_var" (set a secret), "install" (complete an agent installation, e.g. a GitHub App), "custom" (agent-defined step), or "integration" (authorize an OAuth-backed MCP server integration).

    last_verified_at?: string

    When the verifier last ran for this action (ISO 8601). null until the verifier has been invoked at least once.

    last_verifier_message?: string

    Human-readable output from the most recent verifier run. null if the verifier has not run yet.

    org?: string

    ID of the organization this action is associated with (org_...). null when not org-scoped.

    params?: Record<string, unknown>

    Kind-specific structured data used to construct the deep-link for this action. For "env_var" actions includes key and scope; for "install" actions includes installation_kind; for "integration" actions includes mcp_server_ref, and when resolvable also includes provider, integration_id for OAuth handoff, and connection_status ("connected", "disconnected", or "token_expired"). Empty object {} when no additional parameters are needed.

    required: boolean

    true if this action must be completed before the agent is considered fully operational and counts toward the blocking checklist progress bar.

    sort_order: number

    Display order within the same source group. Lower values appear first.

    source: string

    Lifecycle stage that produced this action. One of "setup" (post-install checklist item) or "health" (probe-detected issue).

    status: string

    Current resolution state. One of "pending" (not yet completed), "completed" (resolved), "skipped" (dismissed by the user), or "degraded" (completed but the verifier is reporting a warning).

    title: string

    Short display label for this action, intended for use as a checklist item heading.

    updated_at?: string

    When this health action was last modified (ISO 8601).

    verify_config?: Record<string, unknown>

    Configuration for the action's verifier step. Contains at minimum a type field that indicates which verification affordance to render. Server-internal fields are stripped before this is returned.

    Settings

    Member Visibility

    On This Page

    Properties