Timix.AI

Delete custom field

delete_custom_field

DestructiveIdempotent

Delete a custom-field definition from the organization. If the field is mandatory and already has values stored on entities the service will reject the delete with a clear reason. Returns a preview unless confirm=true is set. Admin role required.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "custom_field_id": "<custom_field_id>"
    },
    "name": "delete_custom_field"
  }
}

Input Schema

Name	Required	Description
`confirm`	No	Set true to perform the action. Omit or false returns a preview only — nothing is written.
`custom_field_id`	Yes	Id of the custom field definition to delete.
`idempotency_key`	No	Optional caller-supplied key; retrying with the same key returns the original result instead of acting twice.

Schema Changelog

Changes observed during successful MCP inspections.

First observedJul 15, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and readOnlyHint=false, so the safety profile is covered. The description adds real context beyond that: the mandatory-field-with-values rejection rule, the preview-by-default behavior, and the admin-role prerequisite. It doesn't spell out what happens to stored values when the delete is permitted, but the core behavioral risks are disclosed.

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?

Four short sentences, front-loaded with the action, then the failure condition, then the preview default and auth requirement. Nothing is repeated and nothing is wasted.

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 destructive, single-parameter delete with no output schema, the definition covers the key facts an agent needs: rejection conditions, preview-vs-act semantics, and the admin role. It could go further by clarifying the effect on stored values when deletion succeeds, but it is largely complete.

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?

Schema coverage is 100%, so all three parameters are already documented, including confirm and idempotency_key. The description's mention that a preview is returned unless confirm=true duplicates the schema rather than adding syntax or format detail. Baseline 3 is appropriate when the schema carries the parameter burden.

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 opens with a precise verb and resource: 'Delete a custom-field definition from the organization.' It names the exact object being removed and its scope, which clearly distinguishes it from siblings like update_custom_field or set_custom_field_value.

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?

It gives clear preconditions: the delete is rejected if the field is mandatory and already has values, and nothing is written unless confirm=true. It also states the admin-role requirement. What's missing is an explicit pointer to an alternative (e.g., deactivating via update_custom_field instead of deleting).

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

All Timix.AI tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?