Skip to main content
Glama

Explain a VibeRaven finding

explain_finding
Read-onlyIdempotent

Use this when the user asks what a VibeRaven finding id means, for example rls_disabled or env_var_drift, or pastes a finding from a VibeRaven 1.6.12 report. Returns what the rule detects in repository files, why it matters, how to fix it and what it does not check, quoted from viberaven.dev with a source link for each part. It does not read the user's repository, database or Vercel project. Known ids: rls_disabled, rls_no_policies, rls_policy_allows_all_read, rls_policy_allows_all_write, security_definer_function_executable, pooler_port_mismatch, service_role_key_in_client_code, env_var_drift. An unknown id returns found: false and the list of known ids.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
gap_idYesThe finding id as printed by VibeRaven, for example rls_disabled.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
foundYes
gap_idNo
detectsNo
named_onNo
known_idsNo
how_to_fixNo
does_not_checkNo
why_it_mattersNo
viberaven_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive and closed-world, but the description adds meaningful scope the annotations cannot express: it never reads the user's repository, database or Vercel project, its content is quoted from viberaven.dev with a source link per part, and an unknown id returns found: false plus the list of known ids. That is exactly the behavioral detail needed to set expectations for a lookup tool.

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 trigger condition, then the return shape, then the negative scope and id list. Every sentence carries distinct information; nothing restates the title or name.

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 one-parameter read-only lookup, the description covers trigger, return content, non-capabilities, and error behavior. An output schema exists, so the brief return-value summary is supplementary rather than a gap, and nothing an agent needs to call this correctly is missing.

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% and the single gap_id parameter is fully described, so the baseline is 3. The description goes further by enumerating the eight known ids, giving format examples, and specifying the unknown-id failure behavior, which meaningfully guides valid input selection.

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 (explain) and resource (a VibeRaven finding id) plus concrete example ids (rls_disabled, env_var_drift), so the agent knows exactly what this returns. It is clearly distinguishable from launch_checklist and search_guides, which are action and documentation-lookup tools respectively.

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?

Gives crisp trigger conditions: 'Use this when the user asks what a VibeRaven finding id means ... or pastes a finding from a report,' which covers the realistic invocation contexts. It does not, however, name siblings such as search_guides as the alternative for general VibeRaven questions, so routing is clear but not fully disambiguated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources