swift_format_run

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

With no annotations provided, the description carries the full burden of disclosure. It clarifies the tool runs lint mode (not fix), which is key. However, it does not mention if any files are modified (it shouldn't be, but it's not stated), the exit behavior (success/failure on lint violations), or whether it requires a specific environment or configuration file.

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, concise and front-loaded with the action and tool name. It uses strong verb 'Run' and specific resource 'swift-format lint'. Every word serves a purpose with no filler.

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 has only 2 parameters, no output schema, and no annotations, the description is mostly complete for a lint-check action. It covers the purpose and mode. However, it could note that results are returned via stderr or exit code, but this is not critical 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?

Schema coverage is 100%, so baseline is 3. The description adds no additional meaning beyond the schema's parameter descriptions ('Path to check formatting', 'Recurse into subdirectories (default: true)'). The parameter semantics are adequately covered by the schema alone.

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 verb 'Run' and the resource 'swift-format lint' with a specific action 'check formatting'. It distinguishes itself from sibling tools like swiftlint_run (a different linter) and swift_format_fix (presumably a fix counterpart) by specifying it runs lint mode.

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 checking Swift file formatting, but does not explicitly state when to use this tool over alternatives like swiftlint_run or swift_format_fix. No when-not-to-use guidance is provided given sibling tools that perform fixes.

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