Skip to main content
Glama

Delete Surface Element

delete_surface_element

Delete a surface element in a document by its element ID. Optionally remove all connectors referencing the deleted element to prevent dangling references.

Instructions

Delete a surface element by id. Set pruneConnectors=true to also delete any connectors whose source or target referenced the deleted element.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceIdNoWorkspace ID (optional if default set)
docIdYesDocument ID
elementIdYesElement ID to delete
pruneConnectorsNoAlso delete connectors referencing this element (default false)
Behavior3/5

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

With no annotations, the description must cover behavioral traits. It discloses the main deletion behavior and the pruneConnectors option, but does not mention irreversibility, permissions, or other side effects. The information is adequate but not comprehensive.

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?

The description is a single, front-loaded sentence that conveys the action and key option without extra words. Every part serves a purpose.

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

Completeness4/5

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

Given the tool's simplicity (4 params, no output schema), the description is fairly complete: it states what it does and the optional behavior. It could mention prerequisites or success/error responses, but overall it suffices.

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

Parameters3/5

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

Since schema description coverage is 100%, baseline is 3. The description adds minimal new meaning beyond the schema—it paraphrases the pruneConnectors effect already in the schema. No additional parameter insights.

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?

The description clearly states the action (delete) and the resource (surface element by id), and distinguishes this deletion tool from siblings like add_surface_element or update_surface_element. It also explains the optional pruneConnectors behavior.

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

Usage Guidelines3/5

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

The description implies usage for deleting a surface element by id but does not explicitly state when to use this tool versus alternatives (e.g., update_surface_element) or provide conditions for use.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/DAWNCR0W/affine-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server