Skip to main content
Glama
Sign In
Itential MCP Server

Itential MCP Server

Official
by itential
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Describe Compliance Report

describe_compliance_report
Read-onlyIdempotent

Fetch detailed compliance report results from Itential Platform by ID to view configuration validation outcomes, rule violations, and per-device compliance status.

Instructions

Retrieve detailed compliance report results from Itential Platform.

Compliance reports contain the results of executing compliance plans against network devices, showing configuration validation outcomes, rule violations, and compliance status for each checked device.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "report_id": "<report_id>"
    },
    "name": "describe_compliance_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
report_idYesThe ID of the report to describe

Output Schema

NameRequiredDescriptionDefault
resultYesCompliance report details containing validation results, device compliance status, rule violations, and configuration analysis

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so the description isn't responsible for safety disclosure. It adds valuable context about what compliance reports contain (validation outcomes, rule violations, status per device), which goes beyond the schema and annotations.

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?

Two concise sentences. The first states the core function, the second explains the underlying concept. No redundant or filler content.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/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, output schema present, annotations covering read-only and idempotent behavior), the description is complete. It explains what the report contains and retrieves, sufficient for an agent to invoke it correctly.

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 description coverage is 100% and the only parameter (report_id) is clearly defined as 'The ID of the report to describe.' The description adds no further parameter-level detail, but the schema sufficiently covers semantics, so the baseline of 3 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 function with a specific verb ('Retrieve') and resource ('detailed compliance report results'). It distinguishes itself from siblings like run_compliance_plan (execution) and get_compliance_plans (listing) by focusing on describing a specific report's results.

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 context—retrieving results after running compliance plans—but it does not explicitly state when to use this tool versus alternatives, nor does it mention exclusions. Sibling names help, but the description itself lacks explicit guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools