Skip to main content
Glama
CoveoSec
by CoveoSec

xql_library_get

Retrieve detailed XQL query libraries from Cortex XSIAM, filtering by query names or tags.

Instructions

Get XQL Queries

Retrieve a detailed list of XQL query libraries. You can filter by list of query names or by list of query tags.

You must have Instance Administrator permissions to run this endpoint.

[POST /public_api/xql_library/get] · Query Library

Example request body:

{
  "request_data": {
    "xql_query_names": [
      "test_ql11",
      "test_ql2",
      "test_ql33"
    ],
    "xql_query_tags": [
      "tag1",
      "tag2",
      "tag3"
    ]
  }
}

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 must disclose behavior fully. It mentions the endpoint and permission requirements but omits the mutual exclusivity of xql_query_names and xql_query_tags. The example request body includes both fields simultaneously, directly contradicting the schema's note that they cannot be used together, which is misleading. It also does not explain the extended_view parameter's effect or return behavior.

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 description has a clear structure with a summary, permission note, endpoint, and example. However, the example is long and misleading (showing both filters together), and it occupies space without adding accurate value. Could be tightened and corrected.

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?

The tool has a nested request_data object, no output schema, and no annotations, so the description must compensate. It fails to describe the return format, error scenarios, pagination, or the mutual exclusivity of the filter parameters. The misleading example further reduces completeness.

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

Parameters2/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 explain all parameters. It mentions filtering by names or tags, but the example incorrectly combines both in one body and does not mention the extended_view parameter. The description adds some meaning but is incomplete and partially misleading.

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 'Get XQL Queries' and 'Retrieve a detailed list of XQL query libraries' with a specific verb and resource. It naturally distinguishes from siblings like xql_library_insert and xql_library_delete by focusing on retrieval.

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 implies usage for retrieving XQL query libraries and notes required permissions (Instance Administrator), but it does not explicitly contrast with sibling tools like xql_query or xql_start_xql_query. No when-not guidance is provided, only implied context from the verb 'Get'.

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