vivado_stop_session

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

No annotations provided; description only says 'stop'. Does not disclose effects of force parameter, timeout behavior, or consequences like unsaved data loss. Minimal behavioral disclosure.

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?

Single sentence is very concise, but it lacks necessary substance. It earns its place by being short, but not by being informative.

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 3 parameters, no schema descriptions, and no annotations, the description is severely inadequate. Does not mention prerequisites (e.g., session must exist), return values, or side effects.

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 0% and description adds no information about parameters. Does not explain session_ref (how to obtain), force (what forcing does), or timeout_seconds (how it affects stopping).

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?

Description clearly states the action (stop) and resource (managed Vivado session). It is unambiguous but lacks differentiation from sibling tools like vivado_session_state or vivado_start_session.

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 on when to use this tool versus alternatives (e.g., vivado_session_state to check state, vivado_start_session to start). No exclusions or prerequisites mentioned.

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