vivado_start_session

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

Without annotations, the description carries the full burden. It only mentions starting a session and optionally opening GUI, but does not disclose what 'managed' entails, effects on existing sessions, or any safety considerations (e.g., destructive actions).

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 a single concise sentence, but it sacrifices detail for brevity. It could include more structured information without becoming verbose. Not excessively long, but insufficiently 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 5 parameters, no annotations, no parameter descriptions, and an output schema not shown, the description is incomplete. It does not cover setup requirements, return value, or how it fits into the overall workflow with sibling tools.

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 0%, yet the description only hints at the open_gui parameter. It does not explain vivado_path, workspace_dir, capability_profile (e.g., meaning of 'safe' vs 'unrestricted'), or startup_timeout_seconds. The description adds minimal value beyond parameter names.

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 verb 'Start' and resource 'managed Vivado Tcl session', and mentions the optional GUI. It distinguishes from sibling tools like vivado_run_tcl or vivado_stop_session, which handle different operations.

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 compared to others, such as prerequisites (e.g., should it be used before running Tcl commands) or scenarios to avoid. The description lacks context for decision-making.

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