Enable or disable a SIP credential

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

Describes side effects in detail: disabling drops Redis HA1/AOR and tears down active registrations but not in-progress dialogs. Also mentions step-up MFA requirement and lists error codes, adding value beyond annotations.

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?

Three sentences with no filler. Front-loaded with the primary action, then side effects, prerequisite, auth, and errors. Every sentence contributes necessary information.

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?

Covers prerequisites, side effects, authentication (step-up MFA), and error codes. No output schema exists, but the description sufficiently prepares the agent for expected outcomes.

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%, so parameters are fully described. The description adds minimal extra meaning beyond the schema, only referencing trunk_list_credentials for the cred_id field.

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?

Clearly states the action (toggle/enable/disable) and resource (SIP credential enabled flag). Distinguishes from sibling tools like trunk_create_credential and trunk_delete_credential by focusing on the enabled flag update.

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?

Explicitly advises using trunk_list_credentials first to find the credential ID. Lists possible errors, which helps in error handling. Could be improved by explicitly contrasting with alternatives (e.g., trunk_create_credential for new credentials).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.