dashy_get_config

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

Annotations already mark readOnlyHint true, so the description's 'Get' is consistent. It adds useful default behavior ('Defaults to conf.yml') and clarifies the output is the full config as JSON, which is not redundant with the output schema. However, no further behavioral traits such as error handling or file path conventions are disclosed.

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 of 12 words. It front-loads the action and resource, with the default behavior appended. No fluff.

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 tool's simple read-only nature, one optional parameter, and an output schema, the description covers the essential information: what it does, the output type, and the default file. It is complete for basic usage.

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 schema has one optional filename parameter with no description (0% coverage). The description adds meaning by stating 'Defaults to conf.yml', indicating the default filename when the parameter is omitted. It does not explain the format or constraints of the filename, but for a single self-explanatory string parameter, this is adequate.

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 'Get a full Dashy config file as JSON', which is a specific verb and resource. The word 'full' distinguishes it from sibling tools like get_key, get_section, and get_item that retrieve parts of the config, and list_config_files that lists files instead of getting one.

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 does not explicitly mention when to use this tool over siblings. It says 'Defaults to conf.yml' but does not give guidance on when to choose get_config versus get_key or get_section. Usage context is only implied by the phrase 'full config'.

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