Skip to main content
Glama
CoveoSec
by CoveoSec

distributions_get_status

Check the status of an installation package using its distribution ID to verify installation progress or completion.

Instructions

Get Distribution status

Check the status of the installation package.

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

[POST /public_api/v1/distributions/get_status] · Endpoint Management

Example request body:

{
  "request_data": {
    "distribution_id": "<distribution ID>"
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataYes
Behavior3/5

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

The description adds the required license, HTTP method, and endpoint, but does not disclose potential side effects (though it implies a read-only operation) or what the status response contains. With no annotations, the description carries the burden, and it provides only minimal behavioral context.

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 concise and appropriately front-loaded with the purpose. The license requirement, endpoint, and example are each relevant, though the example JSON block could be considered slightly verbose for a single-parameter API.

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 the tool's simplicity (one parameter, no output schema), the description covers the essential endpoint and example, but lacks return value information or behavior details. It's adequate but not fully complete for an agent to know what to expect.

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 example request body demonstrates the expected structure with 'distribution_id', and the schema already includes a description for that parameter. The description adds no additional semantic meaning beyond the schema, so a mid-range score is appropriate.

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 tool's purpose: 'Get Distribution status' and 'Check the status of the installation package.' This is a specific verb+resource pairing that distinguishes it from sibling tools like distributions_create or distributions_delete.

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 provides clear context on when to use the tool (checking status of an installation package) and includes required license information. It doesn't explicitly mention alternatives, but the use case is well-defined and unambiguous.

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