tv_pine_patch

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

Description states 'overwrite editor buffer', indicating a write operation, but annotations set readOnlyHint=true, creating a direct contradiction. No other behavioral context (e.g., permissions, reversal) is provided.

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?

Two short sentences, no redundant information. Front-loaded with the action and key constraint. Every sentence earns its place.

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?

Despite low complexity (2 params, no output schema), the description fails to mention return values, error cases, prerequisites (e.g., editor must be open), and the annotation contradiction undermines trust. Incomplete for safe operation.

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 50%: 'source' has a schema description matching the tool description, but 'scriptName' is undocumented in both schema and description. The description adds no new meaning for 'scriptName', leaving the agent uninformed about its role.

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?

Clear verb 'Patch' with explanation 'overwrite editor buffer', identifies resource (Pine editor), distinguishes from siblings like tv_pine_create (create new) and tv_pine_save (save after). Mentions subsequent step, enhancing clarity.

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 instruction to call tv_pine_save afterwards, but does not state when to use this tool vs alternatives (e.g., tv_pine_create) or when not to use it. Context is implied but no exclusions.

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