Skip to main content

What the assistant can do

Through AI access, YTCC offers the assistant a set of tools. The assistant chooses them by itself; you talk to it in plain language. This page lists the tools so that you know what to ask for.

Read the design​

ToolWhat it gives
list_projects, get_project_overviewThe projects the key reaches, and a summary of one project: pages, symbols, popups, layouts and the Global Layout.
read_designThe content of a page, symbol, popup or layout, including the Global Layout.
render_designThe page as an image, so the assistant can check what it drew. At most 10 images per minute.
get_editor_selectionThe page and the objects you have selected in the screen editor.
search_signals, list_signal_types, list_system_signalsSignal names and types, and the built-in System.*, Session.* and Alarms.* signals. No live values.
list_driversThe drivers and devices, without credentials.
list_widget_types, describe_widget, find_elements, list_shapes, list_assetsThe object types with their properties, the shape library and the project's images.
list_elec_symbols, list_elec_sources, get_connection_pointsThe electrical symbols, sources and voltage levels, and the connection points of objects.
get_guide, measure_text, validate_screen, palette_report, get_design_standardDesign guides, text sizes, a check of a page, a report of its colors, and the project's design standard.

Change the design​

ToolWhat it does
create_design, update_design, delete_designCreates, changes or deletes a page, symbol, popup or layout. The Global Layout can be changed but not deleted; a page hides it with Show global layout (see Layouts).
add_widgets, update_widgets, delete_widgets, batch_editAdds, changes or deletes objects; batch_edit does several changes as one.
reorder_widgets, align_widgetsBrings objects forward or back, aligns and distributes them.
bind_widgetsBinds many objects to signals at once.
connect_elec, connect_pipeDraws electrical lines between symbols and pipes between equipment nozzles.
import_svg, shape_operation, upload_assetTurns an SVG drawing into YTCC objects, combines shapes, uploads a small image (PNG, JPEG, WebP or SVG, at most 2 MB) that the assistant sends as text.
create_uploadGives a one-time upload address for a file on disk, valid for 10 minutes: an image of at most 2 MB or a .glb 3D model of at most 25 MB. The assistant sends the file with curl, or opens the address in a browser, chooses the file on the page and uploads it.
apply_design_packageApplies a screen package in one step.
update_project_settingsChanges the display settings of the runtime screen: alarm bar, layer bar, alarm bar style and the height of the control rail.
set_design_standardStores the design standard of the project, with its text roles.

Scripts, event scripts and the code of objects are never changed through AI access.

Define signals, drivers and devices​

In a project in the Engineering phase, the assistant can write configuration definitions: signals, internal tags, drivers, devices, protocol addresses, alarms and history assignments.

ToolWhat it does
get_config_catalogLists what can be written, with the key fields, the columns and the parameter schemas.
list_configReads the rows of a definition, in pages. Passwords and community strings are masked.
plan_config_changesChecks at most 1,000 changes without writing anything. It returns the problems, a summary of the differences and a plan code.
apply_config_changesApplies the plan with that code after you approve the summary. If another change came in between, the assistant makes a new plan.
list_config_changesLists the configuration changes of the project, newest first.

A plan is applied as one all-or-nothing transaction. It appears in Tools › Audit with the source AI, and File › Restore point… can take it back. See Validate, apply and restore. The drivers load the new definitions by themselves; the reply of the assistant lists the drivers that you must restart. These tools change definitions only: they send no command to the field and change no value.

Inspect the drawing and copy a reference​

The assistant compares your reference drawing with what YTCC drew, in the client. These tools measure the drawing:

ToolGives
inspect_regionA zoomed image of an area of the page, with a pixel grid at high zoom, and the objects in the area.
inspect_widgetThe drawn form of selected objects: an image, the SVG and the computed style, such as the font face actually used.
measure_layoutA layout table of selected objects: boxes, gaps to the nearest neighbours and alignment groups.
sample_renderThe pixel colors of the page at points, along a line or in an area.
list_fontsThe YTCC fonts with their weights and the face actually used for each.

To copy a reference page exactly, the assistant can work tile by tile:

ToolDoes
start_replicaOpens a copy session for a page, with a grid of tiles (8 × 5 by default).
save_inventoryStores the inventory of a tile. A tile without an inventory cannot be drawn.
replica_statusShows the state of each tile: none, inventoried, drawn, verified or failed.
verify_tileRecords that a tile matches the reference after a close look. A later change to the tile clears it.
record_verificationRecords that a symbol or a part of a page matches the reference; the part counts as finished only then.

Ready-made prompts​

Clients that show MCP prompts offer five ready-made tasks:

PromptTask
ekran_tasarimiStart the design of a new screen or project: the assistant first asks for the purpose, the scope and the signals.
sembol-olusturBuild a symbol with parameters for an item of a reference drawing, such as a button, a value box or a piece of equipment, and check it.
sayfa-kurBuild a page from a reference: inventory, symbols, instances, alignment, check.
sayfa-dogrulaCheck a page against a list before finishing: symbols, sizes, alignment, text, signals, pipes.
boru-hatti-kurConnect equipment with pipes from their nozzles.

Project phase​

The project phase decides whether the assistant may change the project. In Engineering it can change screens and configuration definitions; in Commissioned it can only read. A user with the Project phase permission changes the phase with Project phase… in the Tools menu of the configuration editor or in the project list, typing the project code by hand and a reason.

Backup before AI and undo​

Before the first change of an assistant session, YTCC keeps a backup of the project marked before AI, outside the normal rotation of the last 10 saves. To return to the state before the assistant started, restore this backup; see Undo, save and restore.

A change that comes more than 30 minutes after the last change of the assistant in the project starts a new session, so YTCC takes a new before AI backup first. If the backup cannot be taken, the change is not made.

The editor follows the changes​

When the assistant changes the open project, the screen editor and the open runtime screens of the project update by themselves. If you have unsaved changes on the same page in the editor, a bar offers Refresh or Later.

While the screen editor is open, it tells the server which page, symbol, popup or layout you are editing and which objects are selected. A request such as "make the selected labels bold" therefore reaches the objects you selected. If nothing is selected, or the selection is older than two minutes, the assistant asks which object you mean.

Design standard and text roles​

The assistant can store a design standard for the project, with text roles such as title, label and value. The roles appear in the editor as Text role; see Object appearance. The AI server keeps the standard for 30 seconds, so a change made in the meantime reaches the assistant within 30 seconds.

Good to know​

Every tool call is written to a log on the server with the key, the tool, the project and the result, but not with the content of the request.