Skip to main content
Glama
CoveoSec
by CoveoSec

dashboards_get

Fetch dashboard details by filtering on name, ID, generation time, or source. Use this API operation to query specific dashboards from the XSIAM system.

Instructions

Get dashboards

Get dashboard details by filtering based on the dashboard name, dashboard ID, time the dashboard was generated, or dashboard source.

You must have Instance Administrator permissions to run this endpoint.

[POST /public_api/v1/dashboards/get] · Dashboards

Example request body:

{
  "request_data": {
    "filters": [
      {
        "field": "name",
        "value": "This is a cool dashboard",
        "operator": "EQ"
      },
      {
        "field": "source",
        "value": "Vitaly Fintushal",
        "operator": "EQ"
      }
    ]
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataYes
Behavior3/5

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

No annotations are provided, so the description carries the burden. It discloses the permission requirement and POST method, which is useful, but it doesn't describe response format, pagination, or error behavior. The 'get' wording implies read-only.

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 mostly front-loaded with a clear purpose, then adds permission, endpoint, and an example. It is slightly redundant with the 'Get dashboards' heading and the body, but the example is valuable and the length is appropriate.

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?

Covers input fields, permissions, endpoint, and provides an example, which is strong. However, with no output schema, it doesn't describe the response structure or how filters combine, leaving some gaps for a complete AI invocation.

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 signal indicates 0% schema description coverage, the actual schema includes detailed field/value/operator descriptions. The description adds a concrete example request body and explains the filtering fields, which goes beyond the schema.

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 dashboard details' and specifies filtering by dashboard name, ID, time generated, or source. This distinguishes it from sibling tools like dashboards_insert and dashboards_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?

Provides clear context including required Instance Administrator permission, the exact HTTP endpoint, and an example request body. It doesn't explicitly name alternatives or exclusions, but the usage context is well-defined.

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