get_scaffold

Retrieve a Bridge Town scaffold file — a small, reusable helper module (such as OutputLineageBuilder) meant to be copied verbatim into a model repo. Use this instead of reconstructing the helper from documentation examples: the returned content is read live from the platform’s source, so it is always byte-exact and current.

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
name	`Annotated[str	None, Field(default=None, description=“Exact scaffold name (e.g. ‘output_lineage’). Omit to list all available scaffolds instead of reading one.”, max_length=128)]`	No	None

Returns

Returns a structured object. Top-level fields:

• matched (boolean)
• name (string)
• description (string)
• target_path (string)
• content (string)
• resource_uri (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "get_scaffold",
  "arguments": {
    "name": "output_lineage"
  }
}

Response

{
  "matched": true,
  "name": "output_lineage",
  "description": "OutputLineageBuilder — the standard-library-and-pandas-only helper for emitting output_lineage.json during a run, so render_native_sheet_cell_explanation can show exact precedents/dependents instead of a literal-value or inferred fallback.",
  "target_path": "lib/output_lineage.py",
  "content": "# ... full contents of output_lineage_helpers.py, byte-exact ...",
  "resource_uri": "scaffold://output_lineage"
}

Notes

• Module: Skills
• Requires authentication via API token or Auth0 JWT.
• Write the returned content to target_path in the model repo (e.g. via create_file/update_file) — do not reconstruct the helper from documentation examples, since a near-miss reimplementation can fail run validation or silently emit a malformed lineage trace.
• Omit name to get the catalog of all available scaffolds instead of one file’s content.