Skip to main content
Glama

Add Config Field

addConfigField

Add a Policy question to this automation. Its key is custom_ plus the label in snake_case, with _2, _3 and so on appended when the key is taken, and it is placed at the end of its section. A module template reinstall never changes a field added here.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNoCode for the field, unique within the automation; derived from the label when left out
typeYesValue type; compound and sourcePointer are template-only
labelYesShort name for the field, shown as its row heading
rolesNoKeys of the process roles whose holders answer this question; empty means anyone
columnsNoRequired for table, refused otherwise
optionsNoRequired for select and multiSelect, refused otherwise
sectionNoSection to add the field to, or null for none
bindingsNoHow the value reaches the automation (context, tool)
questionYesThe setup question asked for this field
fill_modeNoHow the field is filled (interview, setup)interview
automation_idYesThe automation's unique identifier

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / roles
      Added value: +{
      +  "description": "Keys of the process roles whose holders answer this question; empty means anyone",
      +  "items": {
      +    "maxLength": 120,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "maxItems": 100,
      +  "type": "array"
      +}
  2. Changed2 schema fields changed
    • addedInput schema / properties / key
      Added value: +{
      +  "description": "Code for the field, unique within the automation; derived from the label when left out",
      +  "maxLength": 120,
      +  "minLength": 1,
      +  "pattern": "^[a-z0-9][a-z0-9_]*$",
      +  "type": "string"
      +}
    • removedInput schema / properties / required
      Removed value: -{
      -  "default": false,
      -  "description": "Whether the field must be filled",
      -  "type": "boolean"
      -}
  3. Changed3 schema fields changed
    • addedInput schema / properties / columns
      Added value: +{
      +  "description": "Required for table, refused otherwise",
      +  "items": {
      +    "maxLength": 100,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "maxItems": 20,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • changedInput schema / properties / type / description
      Previous value: -"Value type; table, compound and sourcePointer are template-only"New value: +"Value type; compound and sourcePointer are template-only"
    • changedInput schema / properties / type / enum
      Previous value: -[
      -  "freeText",
      -  "identifier",
      -  "number",
      -  "select",
      -  "multiSelect",
      -  "list",
      -  "orderedList",
      -  "personList"
      -]New value: +[
      +  "freeText",
      +  "identifier",
      +  "number",
      +  "select",
      +  "multiSelect",
      +  "list",
      +  "orderedList",
      +  "personList",
      +  "table"
      +]
  4. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations declare a non-read-only, non-idempotent, non-destructive mutation, and the description adds genuinely non-obvious behavior beyond them: the auto-generated `custom_` snake_case key with `_2`/`_3` collision suffixes, end-of-section placement, and survival across module template reinstalls. It does not cover permission requirements or what the response returns.

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?

Two tight sentences with the core action front-loaded and no filler; the key-derivation and persistence details each earn their place.

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 an 11-parameter tool with no output schema, the description covers the non-obvious identity and placement semantics, while the schema fully documents the remaining parameters and their enums. It omits nothing an agent critically needs, though side-effect/return behavior is unaddressed.

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 meaning beyond the schema for the optional `key` parameter (the exact `custom_` + snake_case derivation and collision-suffix rule) and for placement via `section`. The remaining ten parameters are left entirely to the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (add a Policy/config field to an automation) and even explains the derived key format, so the operation is unmistakable. It does not, however, distinguish itself from close siblings like updateConfigField, addConfigSection, or restoreConfigField.

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?

Usage is only implied by the purpose statement (add a new field rather than mutate an existing one). There is no explicit when-to-use/when-not guidance and no routing to alternatives such as updateConfigField or addConfigSection.

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