pio_project_metadata

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

No annotations are provided, so the description carries the full burden. It discloses a significant side effect: 'Triggers platform/toolchain install on first use.' This is valuable behavioral context beyond the schema. It does not mention auth, rate limits, or failure modes, but the install trigger is a key behavioral trait that could affect how an agent uses the tool.

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 two sentences with no fluff. The first sentence lists the metadata contents, and the second provides the use case and side effect. It is efficient and front-loaded, though the second sentence mixes two distinct pieces of information (use case and side effect) without a hard break. Overall, it earns its place.

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 the presence of an output schema, the return values are presumably covered there, so the description doesn't need to detail them. However, the tool has 0% schema parameter coverage, no annotations, and 2 optional params. The description fails to explain project_dir or the behavior when env is null, and it doesn't mention default behaviors. This incompleteness is significant for a tool that may trigger installs.

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?

With 0% schema description coverage, the description must explain the parameters. It only hints at 'per environment', loosely mapping to the 'env' parameter, but it completely fails to mention 'project_dir' or clarify what null/default values mean. An agent would have to guess the exact semantics of these optional parameters, making this a clear gap.

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 identifies the resource as 'Computed build metadata per environment' and enumerates its contents (defines, include paths, compiler paths and flags, library dirs). While it lacks an explicit verb like 'get' or 'retrieve', the noun phrase effectively conveys a retrieval operation. It doesn't explicitly contrast with sibling tools, but the resource type is specific enough to distinguish it from pio_system_info or pio_project_envs.

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 phrase 'Useful for understanding what the compiler actually sees' gives a clear use case, but it does not provide explicit guidance on when to use this tool versus alternatives, nor does it mention any exclusions. Since many sibling tools exist, more direct comparison would be helpful, but the stated use case implies a reasonable selection context.

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