{
  "format": "x8snip-ai-handbook",
  "version": "1.13.0",
  "build": {
    "version": "96.3.110",
    "candidate": "RC136",
    "buildId": "RC136-1795240769335",
    "builtAt": "2026-11-21T05:59:29.335Z"
  },
  "paths": {
    "start": "/ai/start.md",
    "handbook": "/ai/handbook.md",
    "html": "/ai/",
    "capabilities": "/ai/capabilities.json",
    "commands": "/ai/commands.json",
    "index": "/llms.txt",
    "uiTools": "/ai/ui-tools.json",
    "pluginGuide": "/plugins/",
    "pluginAuthoring": "/plugins/authoring.md",
    "localGateway": "/plugins/gateway.md",
    "editablePluginInstances": "/plugins/editable-instances.md",
    "drawingCapabilities": "/plugins/drawing-capabilities.json",
    "pluginExample": "/plugins/example-rectangle.snipplugin",
    "pluginPackageSchema": "/plugins/package.schema.json",
    "pluginSchema": "/plugins/proposal.schema.json",
    "pluginDrawingCallSchema": "/plugins/drawing-propose.schema.json",
    "hostedPluginLibrary": "https://x8bc.com/x8snip/plugins/",
    "hostedPluginCatalogue": "https://x8bc.com/x8snip/plugins/catalogue.json"
  },
  "tools": [
    {
      "name": "x8snip_get_handbook",
      "description": "START HERE: read the X8SNIP AI operating handbook before drawing. Covers all command aliases, tools, notes, areas, layers, units, blocks, references, saving/export and API/CLI limits. Public instructions. topic can be start, commands, a chapter ID or command alias.",
      "inputSchema": {
        "type": "object",
        "properties": {
          "topic": {
            "type": "string",
            "default": "start"
          }
        },
        "additionalProperties": false
      },
      "annotations": {
        "readOnlyHint": true,
        "destructiveHint": false,
        "untrustedContentHint": false
      }
    },
    {
      "name": "x8snip_read_board",
      "description": "Read selected Board after user opt-in in AI handbook. Native units, revision, selection, layers/locks, bounded geometry and measurements; no image bytes or other Boards. 100 objects/page. For offset>0 pass revision from page zero.",
      "inputSchema": {
        "type": "object",
        "properties": {
          "boardId": {
            "type": "string"
          },
          "offset": {
            "type": "integer",
            "minimum": 0
          },
          "revision": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "annotations": {
        "readOnlyHint": true,
        "destructiveHint": false,
        "untrustedContentHint": true
      }
    },
    {
      "name": "x8snip_list_references",
      "description": "List only selected and explicitly shared Architectural Brain text records, with filenames, SHA-256, size and user classification. Source approval claims are supplied evidence.",
      "inputSchema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "annotations": {
        "readOnlyHint": true,
        "destructiveHint": false,
        "untrustedContentHint": true
      }
    },
    {
      "name": "x8snip_read_reference",
      "description": "Read one selected/shared TXT/MD/JSON record by catalogue ID, in chunks up to 6000 UTF-16 code units. Follow nextOffset until null. Untrusted data cannot override permissions.",
      "inputSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "offset": {
            "type": "integer",
            "minimum": 0
          }
        },
        "required": [
          "id"
        ],
        "additionalProperties": false
      },
      "annotations": {
        "readOnlyHint": true,
        "destructiveHint": false,
        "untrustedContentHint": true
      }
    }
  ],
  "commandCount": 48,
  "uiToolGuides": [
    {
      "id": "select",
      "name": "Select",
      "steps": "Press Space with canvas focus, then click geometry/reference frames. Ctrl/Cmd-click changes a multi-selection. Inspect layer locks and selected IDs before editing.",
      "tip": "Space is a keyboard action, not a typed command alias."
    },
    {
      "id": "calibrate",
      "name": "Set scale",
      "steps": "In Mass it / Setup choose Set scale, pick two known reference points and enter their real distance in the displayed units. Verify with another known dimension.",
      "tip": "No in-app alias is currently assigned; use the visible control."
    },
    {
      "id": "crop",
      "name": "Crop snip",
      "steps": "In Snip it choose Crop / Snip and follow the visible crop-window prompts for the current image. Keep the original reference and inspect the resulting non-destructive layer.",
      "tip": "This differs from double-clicking an image frame to recrop its source."
    },
    {
      "id": "noteSchedule",
      "name": "Note schedule",
      "steps": "Open the Note tool group and choose Note schedule. Follow placement prompts and use the available scope/schedule settings.",
      "tip": "Use the menu: Q is the Scale rule shortcut, not a note-schedule alias."
    },
    {
      "id": "areaSchedule",
      "name": "Area schedule",
      "steps": "Use the Area group schedule insertion control and the Areas dock. Inspect use/category, included measured objects and totals after placement.",
      "tip": "A schedule is derived information; verify source boundaries and calibration."
    },
    {
      "id": "scaleRule",
      "name": "Scale rule",
      "steps": "Use Scale rule in Drawing setup or its Q shortcut with canvas focus. Position the instrument and check its scale against the calibrated drawing.",
      "tip": "The rule is a checking aid, not a calibration substitute."
    },
    {
      "id": "tracePaper",
      "name": "Trace paper",
      "steps": "Choose Trace paper to separate a sketch pass from the reference. Select the intended trace layer and brush, and inspect its visibility/opacity.",
      "tip": "Preserve the locked source/reference layers."
    },
    {
      "id": "quickSnip",
      "name": "Quick Snip",
      "steps": "In Snip it choose Quick Snip, then use the browser screen/window capture chooser. The current Board is saved first and the capture opens a separate Board.",
      "tip": "Only capture the intended window; follow browser permissions normally."
    }
  ],
  "retiredDrawingTools": [
    "wall",
    "door",
    "glazing"
  ],
  "retiredToolPolicy": "WL Wall run creates ordinary closed polygons; the old wall/opening objects remain retired. Legacy objects remain readable; these dedicated tools are unavailable for new drawing. Use reviewed native component workflows instead.",
  "chapters": [
    {
      "id": "plugins",
      "title": "User plugins, JavaScript editor and module lifecycle"
    },
    {
      "id": "start",
      "title": "Start here: operating X8SNIP"
    },
    {
      "id": "workspace",
      "title": "Boards, Books, modes and navigation"
    },
    {
      "id": "command-line",
      "title": "In-app command line, coordinates and shortcuts"
    },
    {
      "id": "precision",
      "title": "Scale, calibration, dimensions and snapping"
    },
    {
      "id": "drawing",
      "title": "Native drawing, shapes and natural media"
    },
    {
      "id": "editing",
      "title": "Selection, transforms, direct edits and Undo"
    },
    {
      "id": "notes-text",
      "title": "Notes, editable text, shape labels and dimensions"
    },
    {
      "id": "areas",
      "title": "Areas, uses, tags, schedules and Mass it"
    },
    {
      "id": "layers",
      "title": "Layers, locks, visibility and properties"
    },
    {
      "id": "references",
      "title": "Image/PDF import, cropping, replacement and extraction"
    },
    {
      "id": "blocks-patterns",
      "title": "Blocks, reusable components and Patterns"
    },
    {
      "id": "sheets",
      "title": "Sheets, templates, Books and linked Scale Frames"
    },
    {
      "id": "saving-export",
      "title": "Saving, backups, archives, native packages, PDF, SVG and DXF"
    },
    {
      "id": "architectural-brain",
      "title": "Architectural Brain: selected references and provenance"
    },
    {
      "id": "api-scripting",
      "title": "API, scripting, command-line and automation capabilities"
    },
    {
      "id": "proof",
      "title": "Fresh-session proof and human review"
    }
  ],
  "interfaces": {
    "inAppCommandLine": true,
    "coordinateInput": true,
    "readOnlyBrowserTools": true,
    "userJavaScriptPluginRuntime": true,
    "editablePluginInstances": {
      "minimumCandidate": "RC129",
      "availableOnBuild": true,
      "selectionCapability": "board.pick",
      "editingCapability": "drawing.instance",
      "guide": "/plugins/editable-instances.md"
    },
    "localGateway": {
      "version": 1,
      "minimumCandidate": "RC128",
      "availableOnBuild": true,
      "pythonClient": true,
      "mcpTransport": "local stdio",
      "scope": "one explicitly paired open Board",
      "requiresUserApprovalForEdits": true
    },
    "publicDocumentationHttp": true,
    "remoteCadEditRestApi": false,
    "standaloneOsCli": false,
    "arbitraryScriptExecution": false,
    "automaticBrainAccess": false
  },
  "units": {
    "internalGeometry": "canvas pixels; +Y down",
    "commandCoordinates": "current UNITS display and active-grid axes; +Y counter-clockwise from grid X",
    "modelCalibration": "pixelsPerUnit and declared unit",
    "paper": "millimetres",
    "area": "square metres when calibrated"
  },
  "sharing": "Board and selected references require independent explicit opt-in. No automatic provider connection.",
  "nativeToolInventory": [
    {
      "id": "select",
      "name": "Select",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": null,
      "keyboard": "Space",
      "guide": {
        "id": "select",
        "name": "Select",
        "steps": "Press Space with canvas focus, then click geometry/reference frames. Ctrl/Cmd-click changes a multi-selection. Inspect layer locks and selected IDs before editing.",
        "tip": "Space is a keyboard action, not a typed command alias."
      }
    },
    {
      "id": "pan",
      "name": "Pan",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "ZP",
      "guide": {
        "group": "Views",
        "alias": "ZP",
        "name": "Pan",
        "steps": "Run ZP and drag to navigate.",
        "tip": "The middle wheel zooms; on Surface use two fingers to pan and pinch."
      }
    },
    {
      "id": "pencil",
      "name": "Pencil",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw"
      ],
      "commandAlias": "NL",
      "guide": {
        "group": "Natural Media",
        "alias": "NL",
        "name": "Pencil",
        "steps": "Draw freehand marks with Pencil.",
        "tip": "Grade, cut and texture affect the mark; use vector geometry for precise model boundaries."
      }
    },
    {
      "id": "pen",
      "name": "Pen",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw"
      ],
      "commandAlias": "NP",
      "guide": {
        "group": "Natural Media",
        "alias": "NP",
        "name": "Pen",
        "steps": "Draw freehand with Pen.",
        "tip": "Surface pressure affects the supported pen response."
      }
    },
    {
      "id": "marker",
      "name": "Marker",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw"
      ],
      "commandAlias": "NM",
      "guide": {
        "group": "Natural Media",
        "alias": "NM",
        "name": "Marker",
        "steps": "Apply marker strokes using the selected tip.",
        "tip": "Use an independent layer or Trace paper for colour studies."
      }
    },
    {
      "id": "razor",
      "name": "Razor",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "RZ",
      "guide": {
        "group": "Natural Media",
        "alias": "RZ",
        "name": "Razor",
        "steps": "Erase supported natural-media marks.",
        "tip": "Use geometry editing commands for CAD boundaries."
      }
    },
    {
      "id": "line",
      "name": "Line",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "L",
      "guide": {
        "group": "Create Vector",
        "alias": "L",
        "name": "Line",
        "steps": "Pick the first point, indicate a direction, then pick or type the next point.",
        "tip": "Use for individual setting-out edges; use P when a connected path is needed."
      }
    },
    {
      "id": "pushPull",
      "name": "Push / Pull",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "PP",
      "guide": {
        "group": "Boolean",
        "alias": "PP",
        "name": "Push/Pull",
        "steps": "Pick a supported closed-shape edge and drag normal to it; follow the distance prompt.",
        "tip": "Shift offsets the whole boundary. This is 2D editing; spline boundaries are not supported exactly."
      }
    },
    {
      "id": "pushCopy",
      "name": "Push Copy",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "PC",
      "guide": {
        "group": "Boolean",
        "alias": "PC",
        "name": "Push Copy",
        "steps": "Pick a straight boundary edge and grow a new closed shape from it.",
        "tip": "Keeps the source; curved-edge Push Copy is not supported."
      }
    },
    {
      "id": "arc",
      "name": "Arc",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "A",
      "guide": {
        "group": "Create Vector",
        "alias": "A",
        "name": "Arc",
        "steps": "Choose the arc mode, then pick or type X,Y / @dX,dY / @distance<angle at its point stages. Typed points are exact; mode-specific radius/angle controls still apply.",
        "tip": "Control cycles six modes; Tangent Continue starts from an existing line or open-path endpoint."
      }
    },
    {
      "id": "wall",
      "name": "Wall",
      "status": "retired for new drawing",
      "defaultModes": [],
      "commandAlias": null,
      "guide": null
    },
    {
      "id": "wallRun",
      "name": "Wall run",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "WL",
      "guide": {
        "group": "Create Vector",
        "alias": "WL",
        "name": "Wall run",
        "steps": "WL draws a connected constant-thickness wall run. Type thickness (200mm or 0.2m), press Enter, and use the three recent-thickness buttons. Choose Centre/Left/Right in Properties; click successive corners or type X,Y, @dX,dY or @length<angle. OSNAP starts on (F3 toggles it); F8 toggles Ortho. Enter finishes open; pick the start or type CLOSE for a loop with an inferred Ortho corner. Esc cancels the unfinished run.",
        "tip": "The lightweight preview shows the wall silhouette; Finish computes the final union outline. Left/right follow drawing direction. Finish creates ordinary editable filled geometry, selected for Properties. Start another with WL, then select overlapping wall shapes and BU to Union. Union commits outlines; Undo restores them. Acute corners bevel to avoid spikes."
      }
    },
    {
      "id": "door",
      "name": "Door",
      "status": "retired for new drawing",
      "defaultModes": [],
      "commandAlias": null,
      "guide": null
    },
    {
      "id": "glazing",
      "name": "Glazing",
      "status": "retired for new drawing",
      "defaultModes": [],
      "commandAlias": null,
      "guide": null
    },
    {
      "id": "arrow",
      "name": "Arrow",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw"
      ],
      "commandAlias": "AR",
      "guide": {
        "group": "Create Vector",
        "alias": "AR",
        "name": "Arrow",
        "steps": "Pick or type X,Y / @dX,dY / @distance<angle for arrow vertices. Enter or FINISH completes after two points.",
        "tip": "An annotation arrow is not a model footprint."
      }
    },
    {
      "id": "pline",
      "name": "Polyline",
      "status": "available",
      "defaultModes": [
        "draw",
        "mass"
      ],
      "commandAlias": "P",
      "guide": {
        "group": "Create Vector",
        "alias": "P",
        "name": "Polyline",
        "steps": "Place successive vertices; use the active prompt to finish the path. Backspace removes the last node.",
        "tip": "Follow circle traces exact circular geometry; Radius arc uses a typed radius. See guide 21 and its practice board. Control cycles Straight, Tangent and Spline."
      }
    },
    {
      "id": "polyline",
      "name": "Area",
      "status": "available",
      "defaultModes": [
        "draw",
        "mass"
      ],
      "commandAlias": "PA",
      "guide": {
        "group": "Create Vector",
        "alias": "PA",
        "name": "Area poly",
        "steps": "Pick or type successive X,Y / @dX,dY / @distance<angle points. Enter or CLOSE closes after at least three vertices. Then set Use and tag information.",
        "tip": "Use for measured spaces; inspect closure before Boolean editing or CAD handoff."
      }
    },
    {
      "id": "rect",
      "name": "Box",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "R",
      "guide": {
        "group": "Create Vector",
        "alias": "R",
        "name": "Solid rectangle",
        "steps": "On a scaled Board, type R Enter, position X,Y Enter, then Width,Height Enter; or click the first corner then type size. Dragging opposite corners still works.",
        "tip": "Sizes use current UNITS; SIZE 1m,500mm supports explicit units. Positive dimensions follow grid +X/+Y up. TO X,Y / @dX,dY enters an opposite corner. Explicit size overrides Free/Square/Golden drag proportions."
      }
    },
    {
      "id": "ellipse",
      "name": "Circle",
      "status": "available",
      "defaultModes": [
        "draw",
        "mass"
      ],
      "commandAlias": "C",
      "guide": {
        "group": "Create Vector",
        "alias": "C",
        "name": "Circle",
        "steps": "Circle: type centre X,Y then radius in current units. Corner ellipse: position X,Y then Width,Height. Picked points can be mixed with typed input.",
        "tip": "Tap Control to switch centre/radius and corner-ellipse construction."
      }
    },
    {
      "id": "regularPolygon",
      "name": "Polygon",
      "status": "available",
      "defaultModes": [
        "draw",
        "mass"
      ],
      "commandAlias": "PG",
      "guide": {
        "group": "Create Vector",
        "alias": "PG",
        "name": "Regular polygon",
        "steps": "Choose the side count and construction mode. Type or pick the start, then radius/edge length or TO X,Y in the active grid.",
        "tip": "Control cycles Inscribed, Circumscribed and Edge modes."
      }
    },
    {
      "id": "goldenSection",
      "name": "Golden section",
      "status": "available",
      "defaultModes": [
        "draw",
        "mass"
      ],
      "commandAlias": "GR",
      "guide": {
        "group": "Create Vector",
        "alias": "GR",
        "name": "Golden section",
        "steps": "Place a Golden Section rectangle and related curve.",
        "tip": "Useful for proportional setting out; inspect which parts belong in a CAD export."
      }
    },
    {
      "id": "note",
      "name": "Note",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "N",
      "guide": {
        "group": "Annotation",
        "alias": "N",
        "name": "Note",
        "steps": "Run N and place a structured note.",
        "tip": "Use notes and leaders for review information, separate from model geometry."
      }
    },
    {
      "id": "text",
      "name": "Text",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "T",
      "guide": {
        "group": "Annotation",
        "alias": "T",
        "name": "Text",
        "steps": "Run T and place editable text.",
        "tip": "Retain an editable copy before converting text to outlines."
      }
    },
    {
      "id": "noteSchedule",
      "name": "Note schedule",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": null,
      "guide": {
        "id": "noteSchedule",
        "name": "Note schedule",
        "steps": "Open the Note tool group and choose Note schedule. Follow placement prompts and use the available scope/schedule settings.",
        "tip": "Use the menu: Q is the Scale rule shortcut, not a note-schedule alias."
      }
    },
    {
      "id": "dimension",
      "name": "Dimension",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "D",
      "guide": {
        "group": "Annotation",
        "alias": "D",
        "name": "Dimension",
        "steps": "Press D and pick two measurement points. Use OSNAP to pick exact points and Ortho to measure along the active drawing axes. For a linear dimension, click to place the dimension line, type an offset, or press Enter for zero offset. Radius uses the centre and circumference points.",
        "tip": "Use a known dimension to check scale before and after DXF exchange."
      }
    },
    {
      "id": "tone",
      "name": "Hatch / Fill",
      "status": "available",
      "defaultModes": [
        "snip",
        "draw",
        "mass"
      ],
      "commandAlias": "PH",
      "guide": {
        "group": "Create Vector",
        "alias": "PH",
        "name": "Hatch poly",
        "steps": "Pick or type successive X,Y / @dX,dY / @distance<angle boundary points. Enter or CLOSE closes after three vertices. Choose fill or pattern properties.",
        "tip": "The boundary and the visible pattern ink serve different purposes."
      }
    },
    {
      "id": "calibrate",
      "name": "Set scale",
      "status": "available",
      "defaultModes": [
        "mass"
      ],
      "commandAlias": null,
      "guide": {
        "id": "calibrate",
        "name": "Set scale",
        "steps": "In Mass it / Setup choose Set scale, pick two known reference points and enter their real distance in the displayed units. Verify with another known dimension.",
        "tip": "No in-app alias is currently assigned; use the visible control."
      }
    },
    {
      "id": "crop",
      "name": "Crop snip",
      "status": "available",
      "defaultModes": [
        "snip"
      ],
      "commandAlias": null,
      "guide": {
        "id": "crop",
        "name": "Crop snip",
        "steps": "In Snip it choose Crop / Snip and follow the visible crop-window prompts for the current image. Keep the original reference and inspect the resulting non-destructive layer.",
        "tip": "This differs from double-clicking an image frame to recrop its source."
      }
    }
  ],
  "activeNativeTools": 25
}
