Api security advisories enrich create

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

Annotations already declare readOnlyHint=false, openWorldHint=true and idempotentHint=false, so the safety and external-call profile is partly conveyed. The description corroborates the open-world nature by naming NVD/EUVD, but adds nothing about overwrite behavior (does enrichment clobber manually entered fields?), failure handling, or whether re-running produces different results.

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?

A single short sentence with no wasted words and the key fact (external source) up front. It is arguably under-specified rather than verbose, but structurally clean.

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?

For a one-parameter external-data mutation with no output schema, the description covers the what but not the outcome: which source is chosen when both are possible, whether existing fields are replaced, and what the agent gets back are all unstated. Adequate to attempt the call, not adequate to predict its effect.

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?

One parameter at 0% schema description coverage, so the schema contributes nothing. The description only implies the id refers to "this advisory" — it does not state the identifier format (UUID, ref_id, CVE id) or whether the advisory must already have a source configured, which is the critical precondition for this call.

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?

Specific verb ("Enrich") plus resource ("advisory") and it names the data provenance (NVD or EUVD), so an agent knows this pulls external data into an existing record. It does not differentiate itself from the closely named siblings sync_euvd_create and sync_kev_create, which sound like they do overlapping work.

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?

"Enrich this advisory with data from its source" implies the precondition that the advisory already exists and has a source, but there is no explicit when-to-use vs. sync_euvd_create/sync_kev_create, and no guidance on what to do if the advisory's source is unset or the lookup fails.

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