Skip to main content
Glama

add_vi_to_remediation_task

Associate a Vulnerable Item with a remediation group via the "Remediation Task Item" m2m (sn_vul_m2m_vul_group_item). The group is an sn_vul_vulnerability record that backs the remediation task. [Write — requires WRITE_ENABLED=true]

Instructions

Associate a Vulnerable Item with a remediation group via the "Remediation Task Item" m2m (sn_vul_m2m_vul_group_item). The group is an sn_vul_vulnerability record that backs the remediation task. [Write — requires WRITE_ENABLED=true]

Input Schema

NameRequiredDescriptionDefault
vulnerable_itemYessys_id of the Vulnerable Item to add
remediation_groupYessys_id of the sn_vul_vulnerability group backing the remediation task

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.15.1

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, destructiveHint=false, and the description adds a genuinely useful operational constraint: the call requires WRITE_ENABLED=true. It also discloses the underlying m2m table, which explains that this writes a link record rather than modifying either entity. It does not warn about duplicate associations despite idempotentHint=false.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences: the action and mechanism come first, the entity semantics second, and the bolded write/environment requirement last where it is easy to scan. The m2m table name is implementation-level but still earns its place by clarifying the write target.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter write tool with full annotation coverage and no output schema, the description supplies what matters: what relationship is created, which record type the group must be, and the environment flag needed to succeed. The main gap is behavior on an already-existing association, which matters given idempotentHint=false.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and both parameters already document themselves as sys_ids, so the baseline of 3 applies. The description largely restates the schema's explanation of the remediation_group ('backs the remediation task'), adding a little entity context but no new naming, format, or lookup guidance.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb (associate) and the exact relationship being created (Vulnerable Item ↔ remediation group via sn_vul_m2m_vul_group_item), so an agent can distinguish it from create_remediation_task or list_remediation_task_findings. It stops short of explicitly naming those siblings as alternatives, which keeps it from a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied rather than stated: 'the group is an sn_vul_vulnerability record that backs the remediation task' tells the agent what the remediation_group parameter must point to, which implies this tool is for linking, not creating tasks. There is no explicit when-to-use vs. create/update_remediation_task guidance or prerequisite ordering.

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

Deploy Server

Other Tools