Skip to main content
Glama
CoveoSec
by CoveoSec

featured_fields_replace_ad_groups

Replace all featured active directory groups and organizational units with new specifications. Overwrite existing configuration to update your environment's featured fields.

Instructions

Replace Featured Active Directory Groups

Replace the featured active directory groups and organizational units listed in your environment.

Note: Running this API will delete all existing active directory groups.

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

[POST /public_api/v1/featured_fields/replace_ad_groups] · Incidents

Example request body:

{
  "request_data": {
    "fields": [
      {
        "value": "domain/administrators-group",
        "type": "group",
        "comment": "Administrators-group is a featured AD group"
      },
      {
        "value": "dev",
        "type": "OU"
      }
    ]
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataYes
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 explicitly discloses the destructive behavior ('delete all existing active directory groups') and the required license, which are critical for an agent to safely invoke the tool. It doesn't detail response format, but the core risks are covered.

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 with a clear summary, a warning note, license info, endpoint URL, and an example. Each section adds useful context without excessive verbosity.

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?

For a mutation tool with no output schema, the description covers the essential operational aspects: what it does, the destructive side effect, license requirements, and an example. It is complete enough for an agent to understand the tool's purpose and risk profile.

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

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although the schema itself has rich descriptions for each field, the description adds an example request body that illustrates the exact structure and usage of the nested fields. This provides practical meaning beyond the schema definitions.

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 states a specific action ('Replace') and a specific resource ('featured active directory groups and organizational units'). It clearly distinguishes from sibling tools like featured_fields_replace_hosts and featured_fields_replace_users, which target different resource types.

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?

The description provides clear context by specifying the resource type and including a prominent deletion warning. It does not explicitly name alternatives, but the context makes it obvious when to use this tool versus siblings.

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