Update Edgeless Block

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

With no annotations, the description covers merge behavior for xywh, background format, and ignored fields. However, it doesn't mention error handling, permissions, or response structure.

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

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

The description is concise with three sentences, front-loading the purpose and then providing key behavioral details without redundancy.

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

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

Given 8 parameters, no output schema, and no annotations, the description covers core behavior and merge logic. Missing details on error responses or required permissions limit completeness.

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

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

The description adds meaning beyond the schema for x/y/width/height (merge) and background (format and replacement). For parameters like workspaceId, docId, blockId, the schema already provides descriptions, but the description compensates well for the 50% coverage.

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

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

The description clearly states it partially updates note/frame/edgeless-text blocks by id, specifying which fields (x/y/width/height, background) and their behavior. It distinguishes this tool from other update tools like update_surface_element.

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

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

The description implies usage for updating edgeless block properties, but lacks explicit guidance on when not to use this tool or how it compares to alternatives like update_surface_element or update_doc_title.

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