Skip to main content
Glama
Heliyos MCP server

Heliyos MCP server

Official
by heliyos-ai

Delete records

heliyos_records_delete
DestructiveIdempotent

Permanently deletes 1–100 records of one object type by ID, with no undo. Use it to remove confirmed records from your CRM workspace.

Instructions

Permanently deletes up to 100 records of one object by id. This cannot be undone: confirm with the user first. All ids must belong to the given object_type; the API ignores ids from other objects and does not confirm a count. Returns structuredContent {deleted_count (ids sent), record_ids}.

Input Schema

NameRequiredDescriptionDefault
schema_idNoObject schema id. Required when object_type is "custom"; the error lists the available ones.
record_idsYesIds of the records to delete, 1 to 100.
object_typeYesWhich object: "company", "person", "deal", or "custom" (custom objects also need schema_id).

Output Schema

NameRequiredDescriptionDefault
record_idsYes
deleted_countYesNumber of distinct ids sent; the API does not confirm the count.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is covered. The description still adds real value beyond them: irreversibility, the fact that ids from other objects are silently ignored, and the important caveat that deleted_count reflects ids sent rather than confirmed deletions.

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, front-loaded with the action and its limit, then the safety warning, then the return shape. No filler and no repetition of schema content.

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 destructive batch tool, it covers the essentials: the 100-record cap, the object_type/record_ids coupling, irreversibility, and the return payload. An output schema exists, yet the description's note about deleted_count semantics is still the key detail an agent needs.

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%, so the baseline is 3. The description earns above baseline by explaining cross-parameter semantics the schema cannot: all record_ids must belong to object_type, and mismatched ids are ignored without an error or count confirmation.

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 with scope: "Permanently deletes up to 100 records of one object by id." The batch cap and single-object constraint distinguish it from sibling delete tools (notes_delete, tasks_delete, fields_delete) and from records_update.

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?

Gives one explicit usage directive — "confirm with the user first" — which is valuable for a destructive operation. However, it never names alternatives (e.g., records_update to modify instead of delete) or states when-not to use it, so routing guidance is only implied.

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