ListSupportedOEMs

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

With no annotations, the description carries the transparency burden. The verb 'List' implies a read-only operation, and mentioning the package version adds context, but it does not disclose potential errors, timeout behavior, or output format beyond the literal listing. This is adequate but not rich.

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 a single, front-loaded sentence that states both the primary action and the additional version output. No filler or redundant information; every word 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?

For a simple list operation with no output schema, the description conveys the core output (OEM keys and version) but omits details like the structure of the returned keys or the behavior when the package has no supported OEMs. Given the tool's simplicity and zero annotations, this is minimally complete but not exhaustive.

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, is fully documented in the schema with a description and range, so schema coverage is 100%. The description does not require additional parameter detail, and the baseline of 3 applies because the schema already provides what the agent needs.

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 'List' and identifies the resource 'OEM source keys supported by the installed odse package', plus an additional output of the package version. This clearly distinguishes it from sibling tools that convert or validate records.

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 implies usage: call this tool to discover available OEM source keys and the installed odse package version. However, it does not explicitly state when to prefer this over the sibling tools (ConvertToODSE, ValidateODSERecord) or provide exclusions, so guidance is implicit rather than explicit.

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