set_syntax

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

No annotations are provided, so the description must fully convey behavioral traits. It indicates mutation ('set') but does not disclose side effects, error handling (e.g., if the name does not match), or whether the operation is reversible. The partial-match detail is the only behavioral insight.

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 sentence of 13 words, conveying all essential information without redundancy. Every word contributes to meaning, achieving maximum conciseness.

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?

The tool is simple with one parameter, but the description misses important contextual cues: no mention of what happens if the file is not active, if the syntax name is invalid, or that available syntaxes can be discovered via get_syntaxes. The partial-match feature is helpful, but overall completeness is moderate.

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%, so the description must compensate. It adds that the name supports case-insensitive partial match, which gives some meaning beyond the schema. However, it does not explain the format, source, or valid values of the name parameter, leaving ambiguity.

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 tool sets the syntax of the active file by name, with the specific detail of case-insensitive partial matching. This distinguishes it from siblings like get_syntaxes (which lists syntaxes) and set_setting (which sets a different property).

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 no guidance on when to use this tool versus alternatives. It does not mention prerequisites such as needing to query available syntaxes first via get_syntaxes, nor does it specify when not to use it (e.g., if the file is not active).

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