Skip to main content
Glama

Delete cmdb relation

servicenow_delete_cmdb_relation
DestructiveIdempotent

Deletes a ServiceNow CMDB relation for a specified Configuration Item (CI) using its class name, CI sys_id, and relation sys_id.

Instructions

Deletes the relation for the specified configuration item (CI).

:param className: CMDB class name. :type className: str :param sys_id: Sys_id of the CI. :type sys_id: str :param rel_sys_id: Sys_id of the relation to remove. :type rel_sys_id: str

:return: Response containing the operation result. :rtype: Response

:raises MissingParameterError: If className, sys_id, or rel_sys_id is not provided.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
sourceNo
sys_idNo
classNameNo
attributesNo
rel_sys_idNo
sysparm_limitNo
sysparm_queryNo
api_parametersNo
sysparm_offsetNo
inbound_relationsNo
outbound_relationsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.4.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is covered. The description adds that missing identifiers raise a MissingParameterError, but it does not say what happens to the CI's other relations, whether the deletion cascades, or what the response actually contains.

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

Conciseness3/5

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

The opening sentence is front-loaded and efficient, but the Sphinx-style :param/:type/:rtype/:raises block restates types already present in the schema, adding bulk with limited informational gain.

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

Completeness3/5

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

There is no output schema, so the ':return: Response containing the operation result' note is appropriately included, and the three core parameters are covered. However, with 12 parameters and no annotation-level detail about side effects, the definition leaves significant gaps for an agent deciding how to call it safely.

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 description coverage is 0%, so the description must compensate, and it does document the three semantically important parameters (className, sys_id, rel_sys_id) with their meanings and types. The remaining nine schema properties (data, source, attributes, sysparm_limit, sysparm_query, api_parameters, sysparm_offset, inbound_relations, outbound_relations) are left entirely unexplained, so it only partially fills the gap.

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 states a specific verb+resource ('Deletes the relation') and scopes it to the specified configuration item, which is unambiguous on its own. It does not explicitly name the sibling it contrasts with (create_cmdb_relation, get_cmdb), so it stops short of full sibling differentiation.

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 by the verb and by the docstring's note that className, sys_id, and rel_sys_id must be supplied or a MissingParameterError is raised, which serves as a prerequisite hint. There is no explicit guidance on when to use this versus create_cmdb_relation or other CMDB tools.

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