get_project_state

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only says 'Get...state' and does not explicitly state that the operation is read-only, whether it requires an initialized session, or how it behaves when no project state is available.

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 one concise sentence with no filler, and the key scope is front-loaded. Every word contributes to identifying what the tool returns.

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?

The tool has no required parameters and an output schema exists, so return-value details do not need to be in the description. However, the description still lacks usage guidance, timeout semantics, and any mention of session or project prerequisites, leaving meaningful context gaps.

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?

The only parameter, timeout_s, is not mentioned in the description and has 0% schema description coverage. The description adds no meaning about units, defaults, or why an agent might need to set it.

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 uses a specific verb ('Get') and identifies a clear resource ('current Vivado project, fileset, run, and artifact state'), so an agent can understand this is a state snapshot tool. It does not explicitly distinguish itself from sibling getters like get_run_progress or session_status, though its broad scope helps.

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?

The description gives no guidance on when to use this tool versus related state/status tools such as get_run_progress, session_status, or list_fileset_files. It also does not mention prerequisites like an active Vivado session or an open project.

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