With the Workbench connected, you author shapes through the
shape_workbench_* tools. You drive them conversationally in your AI client; this
page is the map of what they do.
A shape edit is a session. You open a draft, modify the model, compile to check
it, and materialize when you are happy. Drafts do not affect the live graph until
you materialize.
Open a session
| Tool | What it does |
|---|
shape_workbench_open | Start a draft session against a project (mode: "new" or open an existing shape). |
shape_workbench_propose_shape | Generate an initial draft from a plain-language domain brief. |
shape_workbench_access_status | Check what you can edit in this session. |
Model your domain
| Tool | What it does |
|---|
shape_workbench_edit_shape | Edit shape-level metadata (name, display name, description, adherence). |
shape_workbench_add_type | Add an entity type, with its properties. New fields are defined here, at type creation. |
shape_workbench_edit_type | Edit a type’s metadata (description, display name, titular field). |
shape_workbench_edit_property | Edit an existing property on a type (schema patch, required flag). |
shape_workbench_rename_property | Rename a property while preserving its identity. |
shape_workbench_reserve_property | Remove a property and reserve its name. |
shape_workbench_add_relationship | Add a relationship between types. |
shape_workbench_edit_relationship | Edit a relationship. |
shape_workbench_rename_relationship | Rename a relationship while preserving its identity. |
shape_workbench_reserve_relationship | Remove a relationship and reserve its name (requires a rationale). |
shape_workbench_remove_relationship | Remove a relationship. |
Compile and inspect
| Tool | What it does |
|---|
shape_workbench_compile | Compile the draft to validate it and get its version hashes. |
shape_workbench_inspect | Inspect the current draft state. |
shape_workbench_export_schema | Export the compiled schema. |
shape_workbench_preview_operating_surface | Preview the tools this shape will expose to agents. |
Diff and version
| Tool | What it does |
|---|
shape_workbench_diff | Diff the draft against the committed shape. |
shape_workbench_project_grammar | Read the committed shapes attached to a project and validate relationship rules across them. |
shape_workbench_version_graph | View the shape’s version history. |
shape_workbench_plan_migration | Plan a migration between versions. |
shape_workbench_assert_version_alignment | Confirm a session is aligned to a version. |
A typical session
A conversational pass in your client looks like this:
shape_workbench_open against your project with mode: "new".shape_workbench_add_type for each entity type, with its properties.shape_workbench_add_relationship to connect them.shape_workbench_compile to validate and get version hashes.shape_workbench_preview_operating_surface to see the runtime tools the shape
will expose.- When it looks right, materialize it to the project.
Compile early and often. The compile result tells you whether the model is
coherent before you materialize anything.
