Skip to main content
Glama

update_hitl

Destructive

Update a HITL config. Can change name, channels, or timeout.

ACCESS: needs a Proof account. Authenticate this client (Claude Code: /mcp → Authenticate), then call this tool again. start_login does NOT open this tool.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "update_hitl"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesHITL config ID
nameNoNew name (null to clear)
channelsNoUpdated channels
timeout_secondsNoUpdated timeout in seconds (60–86400)

Output Schema

NameRequiredDescriptionDefault
idYesMongoDB ObjectId
nameNo
statusYesStatus of a HITL configuration
keypairYesEncryption keypair metadata (null if not configured)
user_idYesOwner user ID (useful for SDK encryption AAD)
channelsYes
circle_idNoBacking Circle for a circle-backed Approvals config (null for channel-list configs)
created_atYes
profile_idNo
updated_atYes
environmentYes
timeout_secondsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "description": "HITL configuration with messaging channels and timeout",
      +  "properties": {
      +    "channels": {
      +      "items": {
      +        "oneOf": [
      +          {
      +            "additionalProperties": {},
      +            "properties": {
      +              "config": {
      +                "additionalProperties": {},
      +                "properties": {
      +                  "chat_id": {
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "chat_id"
      +                ],
      +                "type": "object"
      +              },
      +              "type": {
      +                "const": "telegram",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type",
      +              "config"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "additionalProperties": {},
      +            "properties": {
      +              "config": {
      +                "additionalProperties": {},
      +                "properties": {
      +                  "bsuid": {
      +                    "type": "string"
      +                  },
      +                  "phone_number": {
      +                    "type": "string"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "type": {
      +                "const": "whatsapp",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type",
      +              "config"
      +            ],
      +            "type": "object"
      +          }
      +        ]
      +      },
      +      "type": "array"
      +    },
      +    "circle_id": {
      +      "description": "Backing Circle for a circle-backed Approvals config (null for channel-list configs)",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "created_at": {
      +      "type": "string"
      +    },
      +    "environment": {
      +      "type": "string"
      +    },
      +    "id": {
      +      "description": "MongoDB ObjectId",
      +      "type": "string"
      +    },
      +    "keypair": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": {},
      +          "properties": {
      +            "has_backup_wrapper": {
      +              "type": "boolean"
      +            },
      +            "has_encrypted_private_key": {
      +              "type": "boolean"
      +            },
      +            "has_wrapped_dek": {
      +              "type": "boolean"
      +            },
      +            "kid": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "kid",
      +            "has_encrypted_private_key",
      +            "has_wrapped_dek",
      +            "has_backup_wrapper"
      +          ],
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Encryption keypair metadata (null if not configured)"
      +    },
      +    "name": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "profile_id": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "status": {
      +      "description": "Status of a HITL configuration",
      +      "type": "string"
      +    },
      +    "timeout_seconds": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "updated_at": {
      +      "type": "string"
      +    },
      +    "user_id": {
      +      "description": "Owner user ID (useful for SDK encryption AAD)",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "user_id",
      +    "channels",
      +    "timeout_seconds",
      +    "status",
      +    "keypair",
      +    "environment",
      +    "created_at",
      +    "updated_at"
      +  ],
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • removedInput schema / properties / channels / items / anyOf
      Removed value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "config": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "chat_id": {
      -            "maxLength": 50,
      -            "minLength": 1,
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "chat_id"
      -        ],
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "telegram",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "config"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "config": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "bsuid": {
      -            "description": "WhatsApp Business-Scoped User ID (e.g. US.abc123...)",
      -            "pattern": "^[A-Z]{2}\\.[a-zA-Z0-9]{10,140}$",
      -            "type": "string"
      -          },
      -          "phone_number": {
      -            "description": "Phone number in E.164 format",
      -            "pattern": "^\\+?[1-9]\\d{6,14}$",
      -            "type": "string"
      -          }
      -        },
      -        "type": "object"
      -      },
      -      "type": {
      -        "const": "whatsapp",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "config"
      -    ],
      -    "type": "object"
      -  }
      -]
    • addedInput schema / properties / channels / items / oneOf
      Added value: +[
      +  {
      +    "properties": {
      +      "config": {
      +        "properties": {
      +          "chat_id": {
      +            "maxLength": 50,
      +            "minLength": 1,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "chat_id"
      +        ],
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "telegram",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "config"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "config": {
      +        "properties": {
      +          "bsuid": {
      +            "description": "WhatsApp Business-Scoped User ID (e.g. US.abc123...)",
      +            "pattern": "^[A-Z]{2}\\.[a-zA-Z0-9]{10,140}$",
      +            "type": "string"
      +          },
      +          "phone_number": {
      +            "description": "Phone number in E.164 format",
      +            "pattern": "^\\+?[1-9]\\d{6,14}$",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": {
      +        "const": "whatsapp",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "config"
      +    ],
      +    "type": "object"
      +  }
      +]
  3. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false and destructiveHint=true, so the mutation risk is known. The description adds the non-obvious auth gate, which is real value beyond the annotations. However it omits the most important behavioral detail for this tool: whether the channels array replaces the existing channel set wholesale, and whether omitting a field leaves it unchanged.

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?

Two tight paragraphs, front-loaded with purpose and then the access constraint. Nothing redundant, though the access note is verbose relative to the one-line purpose.

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?

Output schema exists and schema coverage is full, so return values and field constraints are covered elsewhere. The remaining thing an agent could get wrong is the auth flow, and the description addresses that explicitly.

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%, including per-field descriptions and null semantics for name, so the baseline is 3. The description only restates the three editable fields and adds no format, range, or replacement semantics beyond 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 ('Update a HITL config') and enumerates the mutable fields, which distinguishes it from create_hitl, get_hitl, and delete_hitl by verb alone. It stops short of naming a sibling or clarifying scope, but the intent is unambiguous.

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?

There is no explicit when-to-use or when-not-to-use guidance relative to alternatives. The ACCESS paragraph is genuinely useful operational guidance (it tells the agent that start_login will not unlock this tool and that re-authentication then retry is required), but that is a prerequisite, not usage routing.

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.