Skip to main content
Glama

Define field

define_field

Add a custom field to any object that supports them (core objects with custom fields, or any custom object). field_type is one of text/number/date/select/multiselect/boolean/url, or 'relationship' (then pass target_object — stores the target record's id). select/multiselect need options. Returns the created field definition.

When to use: When an admin wants a new attribute on a core or custom object — text, number, date, choice, boolean, url, or a relationship.

Example: Add a 'square footage' number field to the Property object.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
labelYesDisplay label. Its slug (lowercase, underscores) becomes the field key, which must be unique on the object.
optionsNoThe allowed choices for a select or multiselect field, as labels; at least one is required. Ignored for other types.
field_typeYesThe field's storage type: text, number, date, select or multiselect (pass options), boolean, url, or relationship (a link to another object; pass target_object).
object_typeYesObject key to add the field to — a built-in object that supports custom fields, or any custom object (see describe_schema).
target_objectNoFor field_type relationship: the object key (built-in or custom) whose record id this field stores.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare the write profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false). The description adds useful conditional behavior — relationship requires target_object, select/multiselect need options — and notes it returns the created field definition. However it omits auth requirements, uniqueness/failure behavior, and idempotency nuance beyond the annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action, then 'When to use' and a concrete example, which is good structure. The inline enumeration of every field_type value is somewhat redundant with the schema enum, a minor waste rather than a serious flaw.

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?

With an output schema present, return values need no explanation, and the description covers field types, the relationship special case, options, a usage trigger, and a worked example. It is complete enough to call correctly, though it leaves creation constraints (slug uniqueness, permissions) implicit.

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 description coverage is 100%, so each of the 5 parameters is already documented in the schema. The description restates field_type values and the target_object/options conditions, which only reinforces what the schema provides rather than adding new semantics. Baseline 3 is appropriate.

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+resource ('Add a custom field') and scopes the target ('any object that supports them — core objects with custom fields, or any custom object'). An agent can distinguish it from update_field, archive_field, and define_object without opening a 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?

The explicit 'When to use' line names the trigger (an admin wants a new attribute on a core or custom object) and enumerates the field flavors. It gives clear context but names no alternative (e.g., update_field for modifying an existing field) and states no exclusions, so it stops short of a 5.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources