compile_text_for_target

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

Annotations declare destructiveHint=true and readOnlyHint=false; the description reinforces this by explaining it writes binaries and runs an in-process commandlet. It also discloses the pipeline mapping ('the same pipeline the Localization Dashboard's "Compile Text" button drives'), which adds operational context beyond the annotation. It doesn't mention whether re-running is safe or what gets overwritten in the archives, but the annotations already carry the safety profile.

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?

Front-loaded with the verb and output artifact, followed by the implementation detail and the prerequisite. The return-shape list is verbose but useful given there is no output schema, so it earns its place. Slightly dense but no wasted sentences.

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?

Covers the operation, the pipeline it drives, the prerequisite, and the return shape. With no output schema, listing the return fields is genuinely informative. Wordy but complete for a mutation tool with moderate parameter count.

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 100%, so all three parameters (scope, target_name, culture_name) are documented in the schema itself. The description adds only that target_name identifies 'the target' and that gather must run first; no additional semantics about scope or culture values are provided beyond 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?

States a specific verb (compile) and resource (localization target archives into LocRes/LocMeta binaries), and distinguishes itself from the sibling gather_text_for_target by naming that tool as the prerequisite step. The internal references to GenerateCompileTextConfigFile and UGatherTextCommandlet::Execute make the scope unambiguous.

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?

Explicitly states the prerequisite: 'Run gather_text_for_target first so the archives are up to date.' This names the alternative sibling and the ordering condition, which is exactly the kind of routing guidance an agent needs in a large toolset.

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