Skip to main content
Glama
Heliyos MCP server

Heliyos MCP server

Official
by heliyos-ai

Change a field

heliyos_fields_update
DestructiveIdempotent

Updates one field of a CRM object by field_id, letting you change its label, description, options, required or hidden flag, AI prompt, or type while keeping the field key unchanged.

Instructions

Changes one field of an object by field_id (from heliyos_objects_get): its label, description, options, required or hidden flag, AI prompt, or type. What you leave out is kept. options REPLACES the allowed values, and records holding a removed value keep it as stale text. A type change is refused by the platform when existing values do not fit the new type. The field key never changes. Returns structuredContent {field}.

Input Schema

NameRequiredDescriptionDefault
typeNoNew type; values must fit it.
labelNoDisplay name, for example "Contract value".
hiddenNotrue: hidden from the web app's tables by default.
optionsNoAllowed values of a select or multiSelect field, unique.
field_idYesfield_id: a 24-character hex id.
requiredNotrue: records must have a value.
ai_promptNoMakes this an AI column: the workers fill it from this prompt (text, richText, number, date, select, multiSelect or checkbox only). Filling existing records is started from the Heliyos web app and uses credits.
schema_idNoObject schema id. Required when object_type is "custom"; the error lists the available ones.
descriptionNoWhat the field holds; shown in the web app and read by the workers.
object_typeYesWhich object: "company", "person", "deal", or "custom" (custom objects also need schema_id).

Output Schema

NameRequiredDescriptionDefault
fieldYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations (destructiveHint=true, idempotentHint=true), the description explains exactly why the operation is destructive: options REPLACES allowed values and records holding a removed value keep it as stale text. It also discloses the platform-side refusal on incompatible type changes, that the field key is immutable, and that the response is structuredContent {field}, all of which the annotations do not convey.

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 front-loaded sentences plus a return-value clause, with the highest-risk fact (options replaces values, leaving stale text) surfaced early. No redundant restatement of the name or title.

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 10-parameter destructive mutation with an output schema, the description covers partial-update semantics, the destructive edge case, the type-change refusal, immutability of the key, and the return shape. Nothing an agent needs to call it correctly is missing.

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 that by adding meaning the schema lacks, notably that options overwrites rather than merges and that a type change is rejected when existing values do not fit. It does not otherwise elaborate on individual parameters such as ai_prompt's credit cost or schema_id's requirement, which the schema already handles.

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 specific verb and resource ("Changes one field of an object by field_id") and immediately tells the agent where field_id comes from (heliyos_objects_get), which separates it from heliyos_fields_create and heliyos_fields_delete without opening another schema.

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 states the partial-update contract ("What you leave out is kept") and the preconditions for a type change, which tells the agent how to call it safely. It does not explicitly name the alternative tools (fields_create/fields_delete) or the when-not condition, so it falls short of a full routing statement.

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