Skip to main content
Glama
CoveoSec
by CoveoSec

alerts_get_alerts

Retrieve all or filtered alerts from Cortex XSIAM. Supports filters, sorting, and pagination to efficiently access security alert data.

Instructions

Get all Alerts

Get a list of all or filtered alerts. The alerts listed are what remains after alert exclusions are applied by Cortex XSIAM.

  • Response is concatenated using AND condition (OR is not supported).

  • Maximum result set size is 100.

  • Offset is the zero-based number of alerts from the start of the result set. The response indicates whether an PAN NGFW type alert contains a PCAP triggering packet. Use the Retrieve PCAP Packet API to retrieve a list of alert IDs and their associated PCAP data.

Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus

[POST /public_api/v1/alerts/get_alerts] · Incidents

Example request body:

{
  "request_data": {
    "filters": [
      {
        "field": "severity",
        "operator": "in",
        "value": [
          "medium",
          "high"
        ]
      }
    ],
    "search_from": 0,
    "search_to": 5,
    "sort": {
      "field": "severity",
      "keyword": "asc"
    }
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataNo
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses important behavioral traits such as AND-only filtering, max result size, offset semantics, and PCAP indication. It does not discuss error handling or side effects, but for a read-only list operation this is adequate.

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?

The description is well-structured: a short intro followed by bullet points, a PCAP note, license info, endpoint, and a JSON example. It is slightly longer than necessary but every section contributes useful information. Purpose is front-loaded.

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?

Given the complex nested schema and no output schema, the description provides key contextual details: list of alerts, PCAP indication, max size, offset, and an example request. It does not enumerate alert fields, but that is not essential for selecting and invoking the tool correctly.

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 does not explicitly describe parameters, but it provides a detailed example request body that illustrates how to structure filters, search_from, search_to, and sort. The input schema itself contains rich descriptions, so the example adds practical value but does not fully substitute for parameter semantics.

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 it retrieves all or filtered alerts with a specific verb ('Get a list of all or filtered alerts'). It distinguishes itself from the sibling tool alerts_get_alerts_pcap by noting that PCAP data should be retrieved via the Retrieve PCAP Packet API. The scope and resource are unambiguous.

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

Usage Guidelines5/5

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

Provides explicit usage constraints: AND-only concatenation, maximum result set size of 100, zero-based offset, and license requirements. It also names an alternative (Retrieve PCAP Packet API) for PCAP-specific needs, giving clear when-to-use guidance.

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