Skip to main content
Glama

Nopaque TotalPath

Get Digital Compliance Audit

getDigitalComplianceAudit
Read-onlyIdempotent

Get the compliance report for one chat bot: takes targetRef (required, from listDigitalComplianceAudits) and optional sector. Returns the same report as the voice compliance report (getComplianceReportByPhone), built from the latest run of each catalogue test against that bot, plus channel and targetRef. Use when: the user asks whether a chat bot is compliant or which compliance checks it fails. Read-only. Needs digital:read. Only your workspace's runs are read.

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": {
      "targetRef": "<targetRef>"
    },
    "name": "getDigitalComplianceAudit"
  }
}

Input Schema

NameRequiredDescriptionDefault
sectorNoRestrict the catalogue to tests applicable to this sector.
targetRefYesThe target to report on, e.g. `acme/billing-bot`. A QUERY parameter rather than a path parameter because a targetRef contains slashes. An HTTP API path parameter matches one segment, and percent-encoding does not help — the gateway decodes `%2F` before routing, so the request arrives as several segments and matches no route. Voice's `{phoneNumber}` works only because E.164 has no slashes.

Output Schema

NameRequiredDescriptionDefault
channelNo
targetRefNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds what the annotations cannot: the required digital:read scope, the tenancy boundary ('Only your workspace's runs are read'), and the data provenance ('latest run of each catalogue test'). Return format is only sketched ('plus channel and targetRef'), but an output schema exists, so this is minor.

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 action and required parameter, then when-to-use, then access constraints. Dense but every clause carries information; the parenthetical provenance and equivalence references are the only slightly heavy spots.

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?

For a 2-parameter read tool with full schema coverage, an output schema, and complete annotations, nothing material is missing: purpose, prerequisite source, auth scope, tenancy scoping, and report semantics are all covered.

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 slightly beyond by marking targetRef as required, telling the agent where to obtain it (listDigitalComplianceAudits), and characterizing sector as narrowing the test catalogue rather than changing the target.

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+resource ('Get the compliance report for one chat bot') and immediately differentiates scope: one bot, keyed by targetRef, versus the sibling list tool. It also names the voice analogue (getComplianceReportByPhone) so the agent knows the report content is equivalent across channels.

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?

Explicit 'Use when: the user asks whether a chat bot is compliant or which compliance checks it fails' gives a concrete selection condition, and it names listDigitalComplianceAudits as the source of the required targetRef, establishing the discovery-then-fetch sequence.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.