Skip to main content
Glama
CoveoSec
by CoveoSec

xql_start_xql_query

Initiate an XQL query to run security data searches and investigations. Specify query string, tenants, and timeframe to retrieve results.

Instructions

Start an XQL query

Execute an XQL query.

For more information on how to run XQL queries, see Running XQL query APIs.

Note

To ensure you don't surpass your quota, Cortex XSIAM allows you to run up to four API queries in parallel.

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

[POST /public_api/v1/xql/start_xql_query] · XQL query

Example request body:

{
  "request_data": {
    "query": "dataset=xdr_data | fields event_id, event_type, event_sub_type | limit 3",
    "tenants": [],
    "timeframe": {
      "from": 1598907600000,
      "to": 1599080399000
    }
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataYes
Behavior2/5

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

With no annotations, the description carries the full burden. It mentions license requirements and a quota limit, but fails to disclose key behavior: that this likely starts an asynchronous query, returns an execution ID, and that results must be fetched separately. Saying 'Execute' may even mislead about the synchronous behavior.

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 reasonably structured with a link, note, license, endpoint, and example. It has minor redundancy ('Start' and 'Execute' repeat the same idea) but is otherwise focused and not overly verbose.

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

Completeness2/5

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

For a complex async API with no annotations and no output schema, the description is incomplete. It omits the return value (execution ID), how to poll for results, and any timeouts or error cases, so an agent cannot fully understand the tool's behavior from this description alone.

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?

The description provides an example request body with query, tenants, and timeframe, which helps visualize the format. However, it doesn't explain parameter semantics beyond what the schema already contains, and with 0% schema description coverage it only partially compensates.

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 clearly states it starts/executes an XQL query, with a specific verb and resource. However, it doesn't explicitly differentiate from sibling tools like xql_query or xql_get_query_results, and the dual phrasing 'Start' and 'Execute' slightly blurs the tool's role.

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?

The description includes a link to XQL query API docs and a quota note (max 4 parallel queries), which gives usage context. However, it doesn't explicitly say when to use this tool vs. xql_query or how it fits into the query workflow, leaving usage largely implied.

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