set_string_table_metadata

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

Annotations already declare idempotentHint=true and destructiveHint=true, and the description reinforces idempotency ("set-to-fixed-value") while adding the meaningful precondition that the key must pre-exist. It does not explain what the destructiveHint implies (e.g. overwriting an existing value), but with annotations present the added context is solid.

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 prose is front-loaded and terse, and the inline return-shape block earns its space given there is no output schema. The return block is dense but functional; nothing is wasted.

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 mutation preconditions, discloses the full return shape (compensating for the absent output schema), and its safety profile is already carried by annotations. An agent has everything needed to call it correctly.

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 the baseline is 3, but the description adds semantic value by explaining metadata is per-entry localization data and giving concrete id examples (Comment/Speaker/Context), which the schema does not. It also ties metadata_id/metadata_value to the id->value pairing.

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 (Set) applied to a specific resource (a metadata id->value pair on an existing UStringTable entry), even citing the underlying API (FStringTable::SetMetaData). It is clearly distinguishable from siblings like set_string_table_entry and get_string_table_metadata.

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?

Gives a clear precondition ("the entry (key) must already exist") and frames the use case as filling in per-entry localization data "that the upsert/reader did not expose", which routes the agent appropriately. It stops short of naming the alternative tools explicitly.

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