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

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
exampleNoAn example answer to the question; left out or null for none
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)
guidanceNoWhat to fill in for the question, in plain sentences; left out or null for none
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. Changed2 schema fields changed
    • addedInput schema / properties / example
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "An example answer to the question",
      +      "maxLength": 500,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "An example answer to the question; left out or null for none"
      +}
    • addedInput schema / properties / guidance
      Added value: +{
      +  "anyOf": [
      +    {
      +      "description": "What to fill in for the question, in plain sentences",
      +      "maxLength": 2000,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "What to fill in for the question, in plain sentences; left out or null for none"
      +}
  2. 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"
      +}
  3. 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"
      -}
  4. 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"
      +]
  5. Added

TDQS

A3.9/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false), and the description adds real context on top: the key-naming/collision scheme and, notably, that a template reinstall won't overwrite fields added here. That persistence guarantee is the kind of behavioral trait annotations cannot express.

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 sentences, front-loaded with the core action, then the naming and placement rules. No filler or redundancy; every clause carries information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 13-parameter create tool with no output schema, the description omits which fields are required (automation_id, label, question, type) and how the returned field is identified. The rich schema compensates, but a create operation would benefit from a note on required inputs and the effect on the automation.

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 the baseline is 3. The description elaborates the key derivation (custom_ prefix, snake_case label, _2/_3 suffix on collision), which slightly amplifies the schema's 'derived from the label when left out', but leaves the other 12 parameters entirely to the schema.

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 states a specific verb and resource ('Add a Policy question to this automation') and clearly delimits the tool from siblings like updateConfigField, listConfigFields, and addConfigSection. An agent can identify exactly what this creates without opening the schema.

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?

It implies the context (adding a new field to an existing automation) and states a placement rule, but never says when to prefer this over updateConfigField or how it relates to addConfigSection. No explicit alternatives or when-not-to-use guidance is given.

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