Update Virtual_circuit_termination

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

The description discloses PATCH semantics and partial updates, but does not address the destructiveHint annotation (true) or warn about potential data overwrites. The return format options are mentioned, but behavioral impact beyond update is not covered.

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 concise with two paragraphs and a 'Returns' section. It front-loads key information. Could be improved with bullet points for clarity, but overall no unnecessary text.

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?

With 8 parameters and no output schema, the description is adequate but incomplete. It explains the update mechanism and response format options but does not describe what a Markdown summary looks like, error cases, or prerequisites (e.g., needing the id from a get/list call).

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 description coverage is 50%; the description does not add meaning for undocumented parameters like 'role', 'interface', 'description', or 'virtual_circuit'. It only reiterates the id requirement and response_format option. The description fails to compensate for the missing schema descriptions.

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 action ('Update'), the resource ('virtual_circuit_termination'), and the PATCH semantics. It distinguishes from siblings like 'create' and 'get' by specifying it updates an existing term by id.

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?

Provides explicit guidance: 'Supply the numeric id and only the fields you want to change. Omitting a field leaves it unchanged.' This clearly tells the agent how to use it, but does not explicitly state when to use this over alternatives like create or get, though context implies it.

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