Skip to main content
Glama

get_hitl

Read-only

Get a HITL config by ID. Returns the config including channels, timeout, and status.

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": "get_hitl"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesHITL config ID

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. Changed1 schema field changed
    • removedInput schema / additionalProperties
      Removed value: -false
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already mark this as read-only. The description adds valuable behavioral context: it requires a Proof account, requires client authentication first, and clarifies that start_login does NOT open this tool. It also previews returned fields, though the output schema likely covers those.

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?

Front-loads purpose and return content, then provides a focused access note. Every sentence adds either identification or prerequisite information.

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?

Complete enough for a read-only get-by-ID tool with an output schema and clear authentication prerequisite. It could mention not-found behavior, but the core calling information is present.

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 coverage is 100% for the single id parameter, and its description already says 'HITL config ID.' The description's 'by ID' adds no syntax or format detail beyond the schema, so baseline 3 is appropriate.

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: 'Get a HITL config by ID,' and says it returns channels, timeout, and status. It is clearly a get-by-ID tool, though it does not explicitly name list_hitls as the alternative for browsing configs.

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?

The phrase 'by ID' implies when to use this rather than a list operation, and the access note clarifies the required authentication flow. However, it does not explicitly state when not to use it or directly compare it with list_hitls.

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.