Skip to main content
Glama

run_control_test

Records a control test result as an indicator result on a control's manual indicator, creating the indicator when none exists. Use it to log test outcomes and evidence against ServiceNow controls.

Instructions

Record a control test result: an indicator result (sn_grc_indicator_result) on the control's manual indicator, which is created if the control has none. Requires WRITE_ENABLED=true

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": {
      "control": "<control>"
    },
    "name": "run_control_test"
  }
}

Input Schema

NameRequiredDescriptionDefault
asyncNoRun as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own.
notesNoTest notes/evidence
fieldsNoAdditional field values
resultNoTest result (e.g. "pass", "fail")
controlYessys_id of the control (sn_compliance_control)
indicatorNoOptional indicator (sn_grc_indicator) sys_id to record against

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv5.0.1
    • addedInput schema / properties / async
      Added value: +{
      +  "description": "Run as a background job and return a job_id at once. Poll it with get_job. Calls that take longer than about 20 seconds switch to a job on their own.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / indicator
      Added value: +{
      +  "description": "Optional indicator (sn_grc_indicator) sys_id to record against",
      +  "type": "string"
      +}
    • changedInput schema / properties / result / description
      Previous value: -"Test result/state (e.g. \"pass\", \"fail\")"New value: +"Test result (e.g. \"pass\", \"fail\")"
  2. Addedv4.15.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already flag a non-read-only, non-destructive, non-idempotent, open-world write. The description adds value beyond them by disclosing a concrete side effect: an indicator record is created on the control if one does not exist, and by naming the target table. It does not confirm idempotency behavior or describe the response, so it stops short of a 5.

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?

Two tightly packed clauses, front-loaded with the action and followed by the auto-creation caveat and the config prerequisite. Nothing is wasted, though the relative clause makes it slightly dense to parse in one pass.

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

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a six-parameter mutation tool with no output schema, the definition covers the write target, the auto-create fallback, and the environment prerequisite. The remaining gap is what the call returns (the created/updated indicator result), which matters because async job switching is documented in the schema but not here.

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, but the description adds meaning the schema does not: when the optional 'indicator' sys_id is omitted, the result lands on the control's manual indicator. That clarifies the default-resolution behavior for the only optional domain parameter.

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?

The description states a specific verb ('Record') and resource ('a control test result'), and pins down the concrete artifact written (sn_grc_indicator_result on the control's manual indicator). That is far more precise than a generic 'run test', though it never explicitly contrasts itself with siblings like run_atf_test.

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?

It supplies a real precondition (WRITE_ENABLED=true) and an implied side effect (indicator auto-created when missing), but gives no guidance on when to choose this over other test-running tools such as run_atf_test or run_atf_suite. Usage is implied rather than framed.

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