Skip to main content
Glama
AIops-tools

compliance-aiops

generate_evidence_bundle

Destructive

Assemble and hash-chain-seal audit evidence for HIPAA, PCI-DSS, SOC 2, or GDPR into a tamper-evident compliance bundle with coverage, approvals, and exceptions.

Instructions

[WRITE][risk=medium] Assemble + hash-chain-seal an evidence bundle for a framework.

One-call happy path: coverage + approval trail + exceptions + sealed evidence records → a bundle .json under ~/.compliance-aiops/bundles/. Reads audit DBs and writes a local artifact only; touches no external system.

Args: framework: hipaa / pci_dss / soc2 / gdpr / iso27001 / djcp_l3. period_start / period_end: ISO timestamps bounding the reporting period. out_path: Where to write the bundle (default: the bundle dir). sign: If True and a signing key is stored, attach an HMAC signature. period: Convenience relative window (e.g. "7d", "last-7-days") used only when period_start / period_end are not supplied.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
signNo
periodNo
out_pathNo
frameworkYes
period_endNo
period_startNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, and idempotentHint=false, so the safety profile is covered. The description adds genuinely new context: it reads audit DBs, writes only to a local artifact under ~/.compliance-aiops/bundles/, and touches no external system. It does not say what happens if out_path already exists (overwrite vs error) or what the destructive hint actually refers to, which is a mild gap for a tool annotated destructive.

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?

Front-loaded with the [WRITE][risk=medium] tag, then a one-line summary, then the output/scope sentence, then a tight argument list. Every line adds information and nothing is repeated from the schema or annotations.

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 six-parameter write tool with no output schema and no schema descriptions, the definition covers purpose, scope, target location, parameter precedence rules, and side effects. The description even states where the resulting bundle .json lands, so an agent knows the return artifact without an output schema.

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

Parameters5/5

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

Schema description coverage is 0%, so the description carries the full burden and does so: framework lists all six valid values, period_start/period_end are specified as ISO timestamps, out_path documents its default directory, sign explains the HMAC-attachment condition, and period is documented as a convenience window that applies only when start/end are omitted. This is more than the bare schema could ever convey.

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 and resource ('Assemble + hash-chain-seal an evidence bundle for a framework') and immediately enumerates what the bundle aggregates: coverage, approval trail, exceptions, sealed evidence records. An agent can distinguish this from verify_bundle, export_bundle, and the individual report siblings without opening any schema.

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 'One-call happy path' phrase clearly signals this is the consolidated call that subsumes coverage_summary, approval_report, and exceptions_report, which is real usage context. However, no sibling tool is named explicitly and there is no 'do not use when' clause (e.g., when to prefer export_bundle or a single report), so it stops short of full routing guidance.

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