whmcs_update_domain_lock_statusLock or unlock a domain in WHMCS by providing its domain ID and desired lock status. Control domain transfer security with a single API call.
Lock or unlock a domain
| Name | Required | Description | Default |
|---|---|---|---|
| domainid | Yes | Domain ID | |
| lockstatus | No | Lock status (true to lock) |
Changes observed during successful MCP inspections.
v1.2.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behavioral traits. It only states the action but does not explain whether the change is immediate, requires permissions, or any side effects. The description is minimal for a mutation tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that is front-loaded and contains no unnecessary words. It is appropriately sized for the tool's simplicity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the lack of annotations and output schema, the description should provide more context about the effect of omitting the optional lockstatus parameter, the return value, and any confirmation. It is incomplete for a mutation tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers 100% of parameters with descriptions. The description adds no extra meaning beyond what the schema provides, so it meets the baseline but does not enhance understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'Lock or unlock a domain' clearly states the verb and resource, distinguishing it from the sibling tool whmcs_get_domain_lock_status which reads status. However, it could be more precise by indicating it sets the lock status to the provided boolean.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives like whmcs_get_domain_lock_status or other update tools. There is no mention of prerequisites, when not to use it, or recommended context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.