Member Junction
    Preparing search index...

    Interface DatabaseDesignerPayload

    Root payload passed through the entire Database Designer agent chain.

    The user converses directly with Database Designer. The Requirements Analyst and Schema Designer sub-agents populate the first two sections sequentially before the code-based Validator and Builder take over.

    Subagent mode (mode === 'subagent')

    Invoked by another agent (e.g. Planning Designer) that has already determined what entity is needed. The caller provides callerContext.tableSpecs and the orchestrator skips Requirements Analyst, routing directly to Schema Designer.

    interface DatabaseDesignerPayload {
        BuildAttemptCount?: number;
        callerContext?: DatabaseDesignerCallerContext;
        DatabaseDesignerResult?: DatabaseDesignerResult;
        entityResearch?: ExistingEntityResearch;
        FunctionalRequirements?: string;
        mode?: "standalone" | "subagent";
        SchemaDesign?: SchemaDesignSection;
        ValidationResult?: EntityValidationResult;
    }
    Index

    Properties

    BuildAttemptCount? callerContext? DatabaseDesignerResult? entityResearch? FunctionalRequirements? mode? SchemaDesign? ValidationResult?

    Properties

    BuildAttemptCount?: number

    Number of times the orchestrator has dispatched Database Schema Builder. Incremented by the deterministic intercept in DatabaseDesignerAgent each time Intercept 3 fires. Prevents infinite retry when the builder fails — the framework discards a failed sub-agent's newPayload, so DatabaseDesignerResult never propagates back; without this counter the intercept would re-fire every turn until the agent run is killed.

    Reset to 0 when Intercept 2 fires (user re-approves, triggering fresh validation).

    callerContext?: DatabaseDesignerCallerContext

    Populated by the calling agent in subagent mode. Contains the pre-researched entity spec and invocation metadata. Ignored when mode !== 'subagent'.

    DatabaseDesignerResult?: DatabaseDesignerResult

    Final outcome written by the Schema Builder sub-agent.

    entityResearch?: ExistingEntityResearch

    Existing entity research written by the Schema Designer after it queries the Database Research Agent in Step 1. Used to surface potential duplicates or FK targets to the user. Key matches SubAgentOutputMapping in .database-designer.json.

    FunctionalRequirements?: string

    Natural-language requirements document produced by the Requirements Analyst sub-agent (standalone mode only). Markdown format.

    mode?: "standalone" | "subagent"

    Operating mode set by whoever initiates the agent run.

    • 'standalone': full conversational flow (default when omitted)
    • 'subagent': fast path — caller provides callerContext.tableSpecs, Requirements Analyst is skipped
    SchemaDesign?: SchemaDesignSection

    Schema design artefacts produced by the Schema Designer sub-agent.

    ValidationResult?: EntityValidationResult

    Validation outcome written by the Schema Validator sub-agent.

    Settings

    Member Visibility

    On This Page

    Standalone mode (default)Subagent mode ()
    Properties