Skip to main content
Glama

Scribe Mail

Create a smart field

create_smart_field

Define a new custom smart field, a merge field signature templates and campaign conditions can use. Check list_smart_fields first: labels are unique, and to rename, retype or rebind an existing field use update_smart_field instead. A manual field starts empty; set each teammate's value with update_teammate. Bound to an integration (integration_id + integration_attribute), its values come from that integration and update_teammate can no longer set them; integrations do not fill url fields, so keep a url field manual. Creating the field changes no signature until a template references it. Writes one field and returns it. Needs the smart_fields:write scope; a taken label, an invalid kind or an unknown or unsuitable integration returns 422.

Input Schema

NameRequiredDescriptionDefault
kindNoField type (default text). url/email values are validated; image values are read-only via the API.
labelYesDisplay name for the field (required). Must be unique in the workspace: a label already in use returns 422 `taken`.
contextYesExplain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as "a user", "the customer", or "an account". Example: "Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution."
requiredNoWhether teammates must fill this field (default true when omitted).
integration_idNoUUID of a workspace integration to sync this field's values from, from list_integrations. It must be a directory or HR/enrichment integration that supplies teammate data; any other returns 422. Omit for a manual field.
integration_attributeNoThe integration's attribute key to map (required when integration_id is set; 422 without it).

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • removedInput schema / properties / integration_attribute / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / integration_attribute / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedInput schema / properties / integration_id / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / integration_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / integration_attribute / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / data / properties / integration_attribute / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / integration_id / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / data / properties / integration_id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / slug / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / data / properties / slug / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Changed4 schema fields changed
    • changedInput schema / properties / integration_attribute / description
      Previous value: -"The integration's attribute key to map (required when integration_id is set)."New value: +"The integration's attribute key to map (required when integration_id is set; 422 without it)."
    • changedInput schema / properties / integration_id / description
      Previous value: -"UUID of a workspace integration to sync this field's values from (omit for a manual field)."New value: +"UUID of a workspace integration to sync this field's values from, from list_integrations. It must be a directory or HR/enrichment integration that supplies teammate data; any other returns 422. Omit for a manual field."
    • changedInput schema / properties / label / description
      Previous value: -"Display name for the field (required)."New value: +"Display name for the field (required). Must be unique in the workspace: a label already in use returns 422 `taken`."
    • changedInput schema / properties / required / description
      Previous value: -"Whether teammates must fill this field."New value: +"Whether teammates must fill this field (default true when omitted)."
  3. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare it is a non-destructive, non-idempotent write, but the description adds substantially more: required smart_fields:write scope, the exact 422 failure modes (taken label, invalid kind, unknown or unsuitable integration), the fact that creation has no effect on any signature until a template references it, and that it writes exactly one field and returns it.

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?

Purpose and the list_smart_fields/update_smart_field routing are front-loaded, followed by the manual-vs-bound behavior split and then side effects and errors. Every sentence carries distinct operational information; there is no filler or repetition of the schema.

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 6-parameter mutation tool with an output schema, this covers purpose, prerequisites, alternatives, behavioral branching (manual vs. integration-bound), authorization scope, and error conditions. Return values are handled by the output schema, so nothing an agent needs 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, but the description adds design-level semantics the schema only hints at: manual vs. integration-bound fields, the coupling of integration_id with integration_attribute, and the caveat that integrations do not fill url fields so they must stay manual. It does not cover the required/default behavior of kind or required, though the schema does.

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 ("Define a new custom smart field") and immediately explains what the resource is — a merge field usable by signature templates and campaign conditions. An agent can distinguish it from update_smart_field, delete_smart_field, and list_smart_fields 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 Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit when-to-use (check list_smart_fields first because labels are unique), explicit when-not ("to rename, retype or rebind an existing field use update_smart_field instead"), and names the concrete alternative. It also routes follow-up work to update_teammate for setting values.

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.