Skip to main content
Glama
Sign In
Itential MCP Server

Itential MCP Server

Official
by itential
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Get Compliance Reports By Batch

get_compliance_reports_by_batch
Read-onlyIdempotent

Retrieve per-device compliance report summaries for a specific compliance plan batch run. Use the batch ID from a plan run to inspect results and get report IDs for full details.

Instructions

Retrieve compliance reports produced by a specific compliance plan batch run.

Compliance reports are generated per-device when a compliance plan is executed. All reports produced by a single plan run share the same batch identifier. This tool closes the chain from running a plan to inspecting its results: run_compliance_plan returns instance.batchId, which is passed here to list per-device report summaries, and each report's id can then be passed to describe_compliance_report for full detail.

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": {
      "batch_id": "<batch_id>"
    },
    "name": "get_compliance_reports_by_batch"
  }
}

Input Schema

NameRequiredDescriptionDefault
batch_idYesThe batch ID from a compliance plan run (CompliancePlanInstance.batchId) to fetch reports for

Output Schema

NameRequiredDescriptionDefault
reportsYesList of compliance report brief objects

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.14.1

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, idempotentHint=true, openWorldHint=false), so the bar is lower. The description adds real context absent from structured fields: reports are generated per-device, all reports in a run share one batch identifier. It does not mention pagination or result volume, but the output schema carries return shape.

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?

Front-loaded with the core purpose in the first sentence, then supporting context. Slightly verbose with two sentences of workflow explanation, but each earns its place by disambiguating the tool's position in the chain. No filler.

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?

With an output schema present, the description needn't explain return values, and it doesn't. It fully covers purpose, input origin, and the surrounding workflow, so an agent has everything required to call it correctly.

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?

Schema coverage is 100%, so the baseline is 3. The description goes beyond the schema by stating the origin of batch_id (instance.batchId from run_compliance_plan), which meaningfully clarifies where the value comes from rather than just its type.

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?

States a specific verb ('Retrieve') and resource ('compliance reports') with precise scoping ('produced by a specific compliance plan batch run'). It clearly distinguishes itself from siblings by explaining the boundary with run_compliance_plan (input source) and describe_compliance_report (next step).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly describes the workflow chain: run_compliance_plan returns instance.batchId, which is passed here, and each report's id is then passed to describe_compliance_report. It names the alternatives and the exact condition selecting each, leaving nothing to inference.

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