Skip to main content
Glama
linusdevx
by linusdevx

Undeploy integration artifact

undeploy_integration_artifact
Destructive

Undeploy an integration artifact from SAP CPI runtime by its ID to immediately stop message processing. This destructive action removes the artifact from the live tenant and cannot be reversed.

Instructions

DESTRUCTIVE: Undeploy (remove from runtime) an integration artifact on the live CPI tenant by its runtime ID. This immediately stops message processing for the artifact and cannot be undone.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, and the description adds concrete behavioral consequences: it stops message processing immediately and cannot be undone. It also specifies the environment ('live CPI tenant'). This adds value beyond the annotation without contradicting it.

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

Conciseness5/5

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

The description is a single, densely informative sentence. It front-loads the destructive warning, states the action, and includes key constraints (immediate, irreversible) with no wasted words.

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

Completeness5/5

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

For a tool with one parameter, no output schema, and annotations covering the destructive nature, the description fully explains the action, its effect, and the parameter's meaning. Nothing essential is missing for correct invocation.

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

Parameters5/5

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

The schema provides only a bare 'id' string with 0% coverage, so the description must compensate. It clarifies that the id is the 'runtime ID' of the artifact, giving the parameter meaningful context beyond the schema.

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

Purpose5/5

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

The description clearly states the verb (undeploy/remove), the resource (integration artifact), and the context (live CPI tenant, by runtime ID). It distinguishes from siblings like deploy_integration_artifact by specifying removal from runtime.

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

Usage Guidelines4/5

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

The description clearly implies when to use it (to stop message processing and remove from runtime) and emphasizes the irreversible nature, but it does not explicitly name alternatives or exclusions. Since the sibling deploy_integration_artifact exists, the contrast is implicit, but not explicitly stated.

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