dashy_get_key

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

The annotation readOnlyHint=true already declares the read-only nature. The description adds the list of valid top-level keys, which is useful context, but does not disclose any other behavioral traits such as error handling, default filename behavior, or permissions. With annotations covering the safety profile, 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, concise sentence that immediately states the function and enumerates acceptable inputs. No wasted words or redundant information.

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 an output schema present and a readOnlyHint annotation, the description covers the core purpose and key values. However, the omission of the 'filename' parameter's purpose leaves the tool incomplete for an agent trying to use it correctly, especially given the existence of multiple config files (implied by sibling dashy_list_config_files).

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 description coverage is 0%, and the description only partially compensates by listing valid values for the 'key' parameter. The 'filename' parameter is completely unexplained, leaving its purpose and impact unclear. This is a significant gap for a tool with only two parameters.

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 action ('Get one top-level config key') and enumerates valid values (pageInfo, appConfig, sections, pages). The singular 'one' distinguishes it from dashy_get_config, which presumably returns the entire config.

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 for retrieving a single config key but does not explicitly state when to use this tool over alternatives like dashy_get_config or when not to use it. No exclusions or alternative recommendations are provided.

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