Skip to content
Maglev docs

Architecture review

Subsystem/process map and technical risk flags.

All action kinds · Project workflow

  • Kind: architecture_review
  • Availability: available
  • Registry cost category: one_call
  • Lifecycle stage IDs: concept_architecture

The cost category describes model work in the registry; it is not a manufacturing price or a monetary quote. Read maglev actions kinds --json for current availability and schemas.

What this does

Section titled “What this does”

Returns a draft for review against the project brief and supporting evidence. A completed action does not establish that a physical test, production gate or engineering review has passed.

Input

Section titled “Input”

Send these fields inside the request’s input object. Use only facts you have, and keep unresolved requirements explicit. Optional fields with defaults can be omitted.

Field Type Required Details
subsystems string[] No Max items 40
bomSummary string No Max length 20000
radios string[] No Max items 10
battery string No Max length 1000
Input JSON schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "subsystems": {
      "maxItems": 40,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 500
      }
    },
    "bomSummary": {
      "type": "string",
      "maxLength": 20000
    },
    "radios": {
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 200
      }
    },
    "battery": {
      "type": "string",
      "maxLength": 1000
    }
  }
}

Request the action

Section titled “Request the action”

Prepare action.json with kind: "architecture_review" and an input object matching the schema above.

Replace PROJECT_ID with your saved project ID. Use a new idempotency key for new work and retain it for an identical retry.

Terminal window
maglev actions request PROJECT_ID --input action.json \
  --idempotency-key example-architecture-review-001 --json

Read action.status, action.output, deliveries and any task in the response. Model actions can take several minutes. After a timeout, check saved actions before retrying. See request and recovery behavior.

Output

Section titled “Output”

The schema below describes action.output.result. The saved action.output envelope also contains draft: true and a note. It can be null while an action is running or after a failure; check the status before reading the result. Null or missing facts are unknown; preserve source references and open questions.

Field Type Required Details
subsystems object[] Yes
subsystems[].name string If parent supplied
subsystems[].process string or null If parent supplied The process that makes it, or null if unclear
subsystems[].flags string[] If parent supplied
subsystems[].note string If parent supplied One or two sentences for the founder about this subsystem; never a price or a lead time
risks string[] Yes
assumptions string[] Yes What was assumed in order to write this draft
openQuestions string[] Yes What only the founder, a factory or a lab can answer
sources string[] Yes Repo paths of the passages actually relied on
Output JSON schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "subsystems": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "process": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "pcba",
                  "injection_molding",
                  "cnc",
                  "sheet_metal",
                  "die_casting",
                  "wire_harness",
                  "battery",
                  "motor_actuator",
                  "display",
                  "camera",
                  "power_adapter",
                  "packaging",
                  "off_the_shelf",
                  "other"
                ]
              },
              {
                "type": "null"
              }
            ],
            "description": "The process that makes it, or null if unclear"
          },
          "flags": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "lithium",
                "radio",
                "magnet",
                "long_lead",
                "process_floor",
                "custom",
                "regulated"
              ]
            }
          },
          "note": {
            "type": "string",
            "description": "One or two sentences for the founder about this subsystem; never a price or a lead time"
          }
        },
        "required": [
          "name",
          "process",
          "flags",
          "note"
        ],
        "additionalProperties": false
      }
    },
    "risks": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "assumptions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "What was assumed in order to write this draft"
    },
    "openQuestions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "What only the founder, a factory or a lab can answer"
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Repo paths of the passages actually relied on"
    }
  },
  "required": [
    "subsystems",
    "risks",
    "assumptions",
    "openQuestions",
    "sources"
  ],
  "additionalProperties": false
}