pvsyst_list_components

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

With no annotations, the description carries the full burden. It usefully discloses that the encrypted built-in component database cannot be enumerated, which prevents a wasted call. It omits pagination behavior (limit/offset defaults), result format, and any permission constraints a mutating-adjacent tool might have.

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?

Two compact sentences with no filler, and the scope/limitation is front-loaded. It is efficient, though it could trade one clause for the missing parameter guidance.

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?

For a 5-parameter list tool with zero schema descriptions, no annotations, and no output schema, the description is too thin. An agent cannot tell how query filters, how limit/offset paginate, or what the returned records look like.

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%, so the description must define all five params. It only clarifies component_type values (PAN/OND/BTR/GEN) and the workspace-vs-DataRO source choice (library). The required component_type is unexplained as to case/format, and query, limit, and offset are entirely undocumented.

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 (List) and the exact resource domain (PAN, OND, BTR or GEN loose component files) in workspace or DataRO. This clearly distinguishes it from get_component, create_component, and list_projects siblings, though the name alone ('list_components') would not have conveyed the file-type specifics.

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?

Implicitly scopes usage to workspace or installed DataRO and rules out the built-in database ('not enumerable'), which is useful when-not guidance. However, it never names alternatives (e.g., get_component for a single component) or explains when to prefer one source over the other.

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