Read VNyan settings.json

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

With no annotations, the description fully bears the burden. It discloses: reads from disk, always readable, secrets redacted, and excluded categories. No contradictions or missing behavioral traits.

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 concise sentences. The first sentence states the action and scope, the second adds key behavioral details (source, availability, redaction, exclusions). No 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?

For a simple read tool with one param and no output schema, the description covers source, availability, redaction, and exclusions. It lacks explicit description of the output format, but the purpose is clear.

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 coverage is 100% with an enum and description for 'area'. The description adds value by listing the enum values in context and explaining what is not included (other categories), which supplements the 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?

The description explicitly states 'Reads settings.json' and lists the specific areas covered (tracking/output/graphics/audio/connections/misc). It also distinguishes from sibling tools by listing what is excluded (props, colliders, etc.) and noting their dedicated tools.

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 provides context about the data source (disk) and availability (always readable regardless of VNyan running). It implicitly guides usage by excluding other areas, but does not explicitly state when to use this tool versus alternatives beyond referencing other tools.

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