Skip to main content
Glama

Delete Surface Element

delete_surface_element
Destructive

Delete a surface element by ID and optionally remove linked connectors to clean up dependencies.

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
docIdYesDocument ID
elementIdYesElement ID to delete
workspaceIdNoWorkspace ID (optional if default set)
pruneConnectorsNoAlso delete connectors referencing this element (default false)
Behavior4/5

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

Annotations already show destructiveHint=true. The description adds valuable detail about the 'pruneConnectors' option, which cascades deletion to related connectors, providing behavioral context beyond annotations.

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?

Two concise sentences that front-load the main action and elaborate on an option. No unnecessary words or repetition.

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?

For a delete tool, the description covers the core action and cascading behavior. However, it does not mention error handling (e.g., what happens if element not found) or idempotency, which annotations indicate false. Slightly incomplete but acceptable.

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?

The input schema has 100% coverage, so baseline is 3. The description repeats the pruneConnectors behavior but does not add significant new meaning beyond what the schema provides.

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 a surface element by id'), specifying the resource and method. It distinguishes itself from sibling tools like 'update_surface_element' and 'add_surface_element'.

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 surface elements but does not explicitly state when to use this tool versus alternatives (e.g., removing via other means). No guidance on prerequisites or when not to use it.

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