Pickfix status

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

readOnlyHint=true already establishes that this is a safe, non-mutating read. Beyond that, the description discloses the actual contents of the response — repository, WebSocket port (including the case where there is none), and per-state batch counts — which is meaningful behavioral detail given no output schema exists.

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?

A single sentence that front-loads the action and then lists the returned fields. No filler, no restatement of the title.

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?

With no parameters and no output schema, the description carries the return-value burden and largely discharges it by enumerating the fields returned. Minor gap: the set of possible batch 'states' and what a 'Pickfix link' represents are not defined, but that is not required to invoke the tool correctly.

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 tool takes zero parameters, so the baseline of 4 applies. Nothing in the description is needed to explain inputs, and it correctly implies the call is argument-free and scoped to 'this session'.

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?

States a specific verb ('Show') and resource ('this session's Pickfix link') and enumerates exactly what is surfaced: repository, WebSocket port, and feedback batch counts. It is clearly a session-summary tool, though it never names the sibling pickfix_list_batches, which reports batch data at a different granularity, so differentiation is left to inference.

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?

Usage is implied rather than stated: an agent can infer this is the tool to call to inspect the current session's connection/link state. There is no explicit when-to-use guidance and no mention of when pickfix_list_batches or pickfix_report would be preferable.

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