qt_attach

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

With no annotations, the description fully discloses side effects: injection modifies the target process (loads DLL, starts RPC thread/listener), session dies with the process, and specific error codes (2001, 2002, 2006) are explained. This is thorough and beyond the basic operation.

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 long but every sentence carries meaningful information about prerequisites, compatibility, error handling, and side effects. The main action is front-loaded and the structure is logical, though slightly dense.

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 description covers all necessary context: how to prepare, compatibility requirements, error codes, side effects, and session lifecycle. Since an output schema exists, return format details are appropriately omitted. It is complete for a tool with these complexities.

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 schema only lists 'pid' as an integer with no description. The description compensates by telling the user to find the pid via qt_list_processes and refers to the target process. This gives enough context for a single simple parameter, though it stops short of a formal definition.

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 tool's function: 'Inject the helper library into a running Qt process and open a session.' This is specific and distinguishes it from sibling tools like qt_detach and qt_list_processes.

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?

It provides explicit guidance: use qt_list_processes to find the pid, detach before re-attaching if already attached, and check qt_list_sessions after session death. It also clarifies it does not build automatically and gives the tool sequence when build is missing.

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