uae_source_add_metadata

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

With no annotations, the description bears full responsibility for behavioral disclosure. It only adds 'WRITE' and token requirement, but omits critical traits like idempotency, error behavior on duplicate IDs, or side effects on the registry.

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 very short (one sentence with a prefix), which is concise but lacks essential information. It is front-loaded but does not earn its place due to missing details.

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 9 parameters, no schema descriptions, and no annotations, the description is insufficient. It does not explain return values (despite an output schema existing) nor provide enough context for correct invocation.

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 0%, so the description must compensate. It does not mention any of the 9 parameters (e.g., id, name_en, name_ar, owner, base_url) nor their meaning or constraints. The agent receives no guidance on parameter usage.

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 action ('Add'), the resource ('metadata-only source'), and the target ('local registry'). It effectively distinguishes from sibling tools like 'uae_source_get' (retrieve) and 'uae_sources_list' (list).

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 includes '[WRITE — requires token]' which hints at authentication requirements, but offers no guidance on when to use this tool versus alternatives like 'uae_source_get' or when not to use it. No context for prerequisites or exclusions.

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