Skip to main content
Glama
CoveoSec
by CoveoSec

rbac_get_roles

Retrieve detailed information for one or more named roles in your environment to support access control management and auditing.

Instructions

Get Roles

Retrieve information about one or more roles created in your environment.

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

[POST /public_api/v1/rbac/get_roles] · System management

Example request body:

{
  "request_data": {
    "role_names": [
      "Role1",
      "Role2"
    ]
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataNoA dictionary containing the API request fields.
Behavior3/5

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

With no annotations provided, the description carries the burden. It indicates the operation is a read (retrieve) and mandates specific licenses, but does not disclose error behavior, response structure, or side effects. The read-only nature is implicit but not elaborated.

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 well-structured with title, short description, license requirement, endpoint, and example. Every part earns its place, with no fluff or 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?

The tool has a single parameter and no output schema. The description explains the input but does not clarify what the response contains. For a simple retrieval, this is adequate but not complete, as return details are left unspecified.

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 coverage is 100%, so baseline is 3. The description adds an example request body, which reinforces the schema but does not meaningfully extend parameter semantics beyond what the schema already describes.

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 'Retrieve information about one or more roles created in your environment', using a specific verb and resource. This distinguishes it from sibling RBAC tools like rbac_get_users, rbac_get_user_group, and rbac_set_user_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 implies usage for retrieving role information, and specifies required license editions. However, it does not explicitly compare with alternatives or state when not to use this tool, so it lacks explicit usage 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