Skip to main content
Glama

Update Surface Element

update_surface_element

Partially update a canvas surface element by ID, merging position/size and replacing text or labels. Adjust shapes, connectors, groups, and text without resizing or rebuilding.

Instructions

Partially update a surface element by id. x/y/width/height merge with the element's current xywh (move without resizing, or vice versa). text/label/title replace their Y.Text wholesale. Fields that don't apply to the element's type are reported in the response 'ignored' list.

Input Schema

NameRequiredDescriptionDefault
xNoX position on canvas (shape/text; default 0).
yNoY position on canvas (shape/text; default 0).
modeNoConnector mode: 0=straight, 1=orthogonal (elbow), 2=curve (default 2). Connector only.
textNoText content (shape/text) or connector label. Replaces existing Y.Text on update.
colorNoText color. Shape default `#000000` — keep unless the fill is dark, then pass a contrasting hex. Canvas text default `--affine-text-primary-color` (theme-adaptive). Shape/text.
docIdYesDocument ID
indexNoBlockSuite fractional-index string controlling z-order. On add, defaults to a key above every existing element's index (new elements render on top). On update, replaces the stored value — pass a key less than some existing index to send-to-back, or greater to bring-to-front. Use the value returned by list_surface_elements to pick a specific position.
labelNoConnector label (stored as text on the connector). Connector only.
titleNoGroup title. Group only.
widthNoWidth (shape default 100, text default 200).
filledNoWhether shape is filled (default true). Shape only.
heightNoHeight (shape default 100, text default 30).
radiusNoCorner radius for rect (0.1 = rounded). Shape only.
strokeNoConnector stroke color (default '--affine-text-primary-color' — theme-adaptive, near-black in light / near-white in dark). Accepts any CSS color or AFFiNE palette token. Connector only.
childrenNoChild element ids. Group only.
fontSizeNoFont size (shape default 20, text default 16). Shape/text.
sourceIdNoConnector source element id. Connector only.
targetIdNoConnector target element id. Connector only.
elementIdYesElement ID to update
fillColorNoFill color. Prefer the `--affine-palette-shape-<color>` family (yellow/orange/red/magenta/purple/navy/blue/green/teal/grey/white/black). These are fixed colors — AFFiNE shape colors are not theme-adaptive by design. Shape only.
shapeTypeNoShape type (default rect). Shape only.
fontWeightNoFont weight (shape default 600, text default 400). Shape/text.
strokeColorNoStroke color. Prefer the `--affine-palette-line-<color>` family (same color names as fillColor). Fixed colors, not theme-adaptive. Shape only.
strokeStyleNoStroke style. Shape/connector.
strokeWidthNoStroke width (default 2). Shape/connector.
workspaceIdNoWorkspace ID (optional if default set)
sourcePositionNoSource [x,y]: relative [0-1] if sourceId set, absolute otherwise. Connector only.
targetPositionNoTarget [x,y]: relative [0-1] if targetId set, absolute otherwise. Connector only. When both source/target are bound by id and neither position is provided, endpoints snap to the BlockSuite side-midpoint facing the other endpoint so connectors flow in a clear direction. Pass [0.5,0] top, [0.5,1] bottom, [0,0.5] left, [1,0.5] right to force a specific side.
expectedRevisionNoOptional read_doc revision of this primary document. Reject stale content before writing. Covers document content, not workspace metadata; requires all writers to share one MCP server.
rearEndpointStyleNoRear endpoint style (default Arrow). Connector only.
frontEndpointStyleNoFront endpoint style (default None). Connector only.

Output Schema

NameRequiredDescriptionDefault
okNo
codeNo
typeNo
errorNo
changedNo
detailsNo
ignoredNo
updatedNo
causeCodeNo
elementIdNo
retryableNo
recoveryGuidanceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.10.2

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations by disclosing two non-obvious behaviors: geometry fields merge with existing xywh while text/label/title clobber the underlying Y.Text wholesale, and mismatched fields are silently reported instead of rejected. That is genuine mutation-context information an agent cannot get from readOnlyHint=false or destructiveHint=false. Missing are error/conflict behavior and any hint about why idempotentHint is false for these merge semantics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences: identity and operation first, then the merge rule, then the replace rule, then the failure-ish case. Zero redundancy and nothing buried at the end that should be up front.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 31-parameter mutation tool with full schema coverage, full annotations, and an output schema, the description supplies exactly the missing layer — the semantics of combining fields — and even references the 'ignored' response field. Nothing essential to invoking it correctly is absent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% across 31 parameters, so the per-field documentation is already carried by the schema; the description earns extra credit by explaining the interaction between x/y/width/height and the current geometry, which no individual parameter description states. It does not, however, group or prioritize the type-scoped families (shape vs connector vs group) beyond one sentence.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Partially update a surface element by id") and pins down the partial-update contract immediately, which cleanly separates it from add_surface_element, delete_surface_element and list_surface_elements. An agent knows exactly what class of operation this is without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explains when to use this over a full write by describing the merge-vs-replace rule ("move without resizing, or vice versa") and warns that type-inapplicable fields land in the 'ignored' list rather than erroring. It does not explicitly name a sibling alternative or state prerequisites such as needing an existing elementId, so it falls short of 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools