roslyn:sync_documents

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

Describes handling of modified, new, and deleted files. Since no annotations exist, description fully discloses behavior. Also notes performance relative to load_solution.

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?

Well-structured with sections, no wasted words. Every sentence adds value.

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?

Complete for a sync tool; no output schema needed. Could mention return value but not essential. Sibling context 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?

Single parameter filePaths with schema description coverage 100%. Description adds usage examples, slightly exceeding baseline of 3.

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?

Description states 'Synchronize document changes from disk into the loaded solution' with clear verb and resource. It distinguishes from siblings like load_solution by noting speed advantage.

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?

Explicit 'WHEN TO CALL' section tells when to use (after Edit/Write tools, deletions) and when not needed (after SharpLensMcp tools). Usage examples with optional filePaths further clarify.

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