Build Blocks portal upload JSON

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

No annotations are provided, so the description carries full burden. It discloses key behaviors: no translation performed ('translate them yourself first'), moduleName resolution cached to disk, and the computed IsPartiallyTranslated based on culture completeness. It stops short of explicitly saying it does not perform the actual import, but 'Pure JSON assembly' strongly implies it.

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?

Three dense sentences; each adds value. Front-loaded with the primary purpose and followed by necessary caveats and alternatives. Slightly long but every clause earns its place.

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?

With no output schema and no annotations, the description explains the output array shape, the caching behavior, the translation prerequisite, and tool alternatives. It gives enough context to use the tool correctly in a workflow. Could add error cases, but overall quite complete.

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 documents 3 of 4 params (moduleId, tenantId, moduleName) with descriptions, but the required entries param has no schema description. Description compensates by explaining the expected entry content (already-translated keys, 7 cultures) and the exact output fields, adding meaningful context 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?

Clear and specific: 'Pure JSON assembly' plus the exact output shape ('stamps them into the exact array shape the Blocks portal JSON import expects'). Distinguishes itself from siblings by naming sync_keys and search_keys as alternatives for different cases.

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 guidance: 'Prefer sync_keys for the common case' and 'Run search_keys first to avoid re-uploading keys that already exist.' This clearly states when to use this tool vs the alternatives, covering both prerequisites and exclusions.

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