Skip to main content
Glama

Note an exception

note_exception

Record a testing exception with its root cause, impact, and any compensating control to document control failures and support deficiency classification.

Instructions

Record an exception identified during testing, with root cause, impact and any compensating control.

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": {
      "engagementId": "<engagementId>",
      "testResultId": "<testResultId>",
      "reference": "<reference>",
      "description": "<description>"
    },
    "name": "note_exception"
  }
}

Input Schema

NameRequiredDescriptionDefault
impactNo
referenceYesThe sample item reference the exception relates to.
rootCauseNo
descriptionYes
engagementIdYes
testResultIdYes
compensatingControlNo

Output Schema

NameRequiredDescriptionDefault
exceptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

B3.2/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It implies a write operation but says nothing about required permissions, whether the record is immutable or editable afterward, whether a testResultId must already exist, or what happens on duplicate references.

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?

A single front-loaded sentence with the verb first and no filler. It is efficient, though the brevity is partly the source of the transparency and parameter gaps.

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?

An output schema exists, so return values need not be described. For a 7-parameter mutation tool with no annotations and near-zero schema coverage, though, the description omits prerequisites (e.g. an existing test result) and the linkage between testResultId and the exception being recorded.

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 only 14%, so the description must compensate. It names three otherwise-undocumented parameters (rootCause, impact, compensatingControl), adding real meaning, but leaves engagementId, testResultId and description unexplained beyond their names.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Record an exception') and anchors it in context ('identified during testing'), which distinguishes it from the read-side sibling list_exceptions. It does not explicitly name alternatives like record_test_result, so it falls short of full sibling differentiation.

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 phrase 'identified during testing' implies the workflow stage at which this tool applies, giving weak implicit guidance. However, it names no alternatives and no when-not-to-use conditions, so an agent must infer the relationship to record_test_result and list_exceptions on its own.

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