Skip to main content
Glama
CoveoSec
by CoveoSec

widgets_delete

Delete widgets from your XSIAM environment by filtering on title or created_by. Requires Instance Administrator permissions.

Instructions

Delete widgets

Delete the widgets retrieved by the Get widgets API.

You must have Instance Administrator permissions to run this endpoint.

[POST /public_api/v1/widgets/delete] · Widgets

Example request body:

{
  "request_data": {
    "filters": [
      {
        "field": "title",
        "value": "Widget A",
        "operator": "EQ"
      },
      {
        "field": "created_by",
        "value": "John Doe",
        "operator": "EQ"
      }
    ]
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataYes
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions permissions and the endpoint but does not disclose that deletion is permanent, that multiple widgets can be deleted based on filters, or what the response contains. This is a significant gap for a destructive operation.

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 concise and well-structured: a clear summary, followed by a permission note, endpoint, and a single illustrative example. Every sentence adds value without redundancy.

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?

Given no annotations, no output schema, and a nested request structure, the description is not fully complete. The example and permission note provide useful context, but the omission of irreversibility, bulk-delete semantics, and response format leaves gaps for an agent invoking a destructive operation.

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. It provides a concrete example request body with realistic filter values, illustrating the nested structure of request_data.filters. However, it does not explain the allowed enum values for field or operator beyond the example, leaving agents to rely on the misaligned 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 uses a specific verb 'Delete' and resource 'widgets', immediately clarifying the action. The additional sentence 'Delete the widgets retrieved by the Get widgets API' distinguishes it from sibling tools like widgets_get and widgets_insert.

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?

It states a clear prerequisite: 'You must have Instance Administrator permissions to run this endpoint.' The phrase 'Delete the widgets retrieved by the Get widgets API' implies a workflow with the Get API, though it does not explicitly name alternatives or when-not-to-use scenarios. The example request body further illustrates the intended usage with filters.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/CoveoSec/xsiam-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server