whmcs_get_domain_lock_statusRetrieve the current registrar lock status for a domain using its WHMCS Domain ID. Use this to verify if a domain is locked or unlocked before processing transfers or modifications.
Get lock/unlock status for a domain
| Name | Required | Description | Default |
|---|---|---|---|
| domainid | Yes | Domain ID |
Changes observed during successful MCP inspections.
v1.2.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description must convey behavioral traits. It indicates a read operation ('get') but lacks details on safety (e.g., idempotent), error handling if domain ID is invalid, or permission requirements.
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 very short (9 words), making it concise. It front-loads the action and resource, but could include a bit more context without becoming verbose.
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 tool has no output schema, the description should hint at the return format (e.g., returns 'locked' or 'unlocked' string). It does not, leaving the agent to guess. Also lacks explanation of input validation or default behavior.
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?
Schema coverage is 100% with parameter description 'Domain ID'. The tool description adds no extra meaning beyond the schema. Baseline score of 3 applies as the schema already documents the parameter well enough.
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 clearly states the tool retrieves the lock/unlock status for a domain, using a specific verb and resource. It distinguishes itself from the sibling 'whmcs_update_domain_lock_status' which sets the status.
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?
The description gives no explicit guidance on when to use this tool versus alternatives. It implies use for checking status, but does not mention prerequisites (e.g., domain must exist) or scenarios like checking before updating.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.