Skip to main content
Glama

av_explain_finding

Explain a finding's structured edge evidence and remediation guidance using the same repo snapshot and findings index as layering checks; pass workspace absolute repo path.

Instructions

解释某条 finding 的结构化边证据与修复建议。默认与 av_check_layering 使用同一仓库快照口径和 findings 索引(不含 inventory)。from=session 时只读本轮报告,找不到就报错,不会静默改扫全楼。必须显式传当前工作区绝对路径 repo。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fromNo从会话报告取本轮红灯;报告不存在或 findings 为空时返回 NO_SESSION_FINDING,绝不改扫全楼
repoYes必填。当前工作区根目录的绝对路径。
ruleNo规则名(cross-layer-violation, layer-skip, removed-type, new-external-dep, public-surface-changed, schema-touched, invariant-broken, intent-mismatch, behavior-untested)
indexNo问题列表中的序号(从0开始)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.12.2-rc.3

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations the description carries the full burden, and it does disclose non-obvious behavior: the shared snapshot/index basis, session mode being read-only against the current round only, hard-error rather than silent full rescan, and repo being mandatory. It still omits what the returned evidence/fix structure looks like or permission requirements.

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?

Three tight sentences that front-load the core action before the snapshot/session caveats and the required-parameter note. No padding, though the repo reminder is somewhat redundant with the schema.

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 finding-explanation tool with no output schema, the description covers inputs, snapshot semantics, and failure behavior adequately. A brief note on what the explanation contains would close the remaining gap.

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 coverage is 100%, so the baseline is 3. The description reinforces that repo must be an absolute workspace path and that from=session restricts the lookup, but both points are already stated in the schema, adding little beyond it.

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 (某条 finding), plus what it returns conceptually — 结构化边证据与修复建议. It names av_check_layering to establish lineage, but does not sharply contrast itself with the other siblings (av_session_report, av_status), so sibling differentiation is partial.

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?

Explains default behavior (same snapshot/index as av_check_layering, excluding inventory) and when the from=session path applies, including that a missing report errors instead of falling back to a full rescan. It does not explicitly tell the agent when to prefer this over av_check_layering or av_session_report.

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