files_read_config_file

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

No annotations provided. Description states it reads a file, but does not disclose behavior on missing files, permissions, or side effects. Basic transparency from verb but lacks depth.

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 sentences, front-loaded with purpose, followed by relevant examples. No wasted words.

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 one-parameter read tool with an output schema, description is nearly complete. Lacks error handling notes, but output schema likely covers return format.

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 has 0% description coverage for 'relative_path'. Description provides concrete examples ('automations.yaml', 'packages/lights.yaml') that clarify usage and format beyond raw schema.

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?

Clear verb+resource (Read config file) with specific context (relative to HA config dir). Examples differentiate from sibling file operations like write/delete/append.

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?

No explicit when/why to use this tool over siblings. Examples imply it's for reading YAML files, but no guidance on alternatives like files_list_config_files or files_validate_yaml_content.

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