Skip to main content
Glama

get_instance_scan_findings

Read-only

List Instance Scan findings to identify best-practice violations and filter by check name, target table, or suite result.

Instructions

List Instance Scan findings (scan_finding) — best-practice violations, optionally by check or suite result

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_instance_scan_findings"
  }
}

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.
checkNoFilter by check name (contains)
limitNoMax records (default 50)
tableNoFilter by target table
suite_resultNoFilter by scan suite result sys_id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field 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"
      +}
  2. Addedv4.15.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile needs no restating. The description adds only that results are best-practice violations; it says nothing about result volume, default cap, or the async job fallback — the latter is covered by the async parameter's own schema text rather than the description.

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?

One front-loaded sentence names the resource first, then qualifies it with the entity type and filter options. No filler or repetition.

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 read-only, zero-required-parameter list tool with full schema coverage and annotations, this is close to complete. The only real gap is that, with no output schema, the description never sketches what a returned finding contains.

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 100% and each of the five parameters is documented inline (async job behavior, contains-match on check, limit default 50, table, suite_result sys_id). The description restates only the check and suite_result filters, adding no syntax or matching semantics beyond the schema.

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 (List) and resource (Instance Scan findings / scan_finding) and clarifies what a finding is ('best-practice violations'). It is distinguishable from siblings like list_scan_suites or scan_vulnerabilities, though it does not explicitly name any alternative.

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?

'optionally by check or suite result' implies the filtering scenarios, but there is no explicit when-to-use/when-not guidance, no prerequisite (e.g. knowing a suite_result sys_id), and no routing to related tools such as list_scan_suites.

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