Skip to main content
Glama

VibeRaven Guides

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.5.3 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.6/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, and the description adds real context beyond them: static answers quoted from viberaven.dev with per-part source links, an explicit statement that no repository/database/Vercel access occurs, and the failure path ('An unknown id returns found: false and the list of known ids'). No contradiction with the annotations; it reinforces them.

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?

Front-loaded with the trigger sentence, then output shape, then boundary, then the id list. Every sentence carries information, though the eight-item id enumeration is a dense block that partially duplicates the parameter discussion and could be trimmed or deferred to the schema.

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?

With an output schema present, return values need not be detailed, and the description covers triggers, scope boundaries, source attribution, and the not-found case. 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 schema already gives format and an example, so the baseline is 3. The description goes further by enumerating all eight known ids, which the schema does not express as an enum, and by documenting the unknown-id behavior — meaningful added semantics for the single parameter.

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?

Specific verb+resource: explains what a VibeRaven finding id (e.g. rls_disabled, env_var_drift) means, and enumerates the concrete outputs (what the rule detects, why it matters, how to fix, what it does not check). The resource is unambiguous against siblings launch_checklist and search_guides, so an agent can separate them without opening a schema.

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?

Trigger conditions are explicit and concrete: 'Use this when the user asks what a VibeRaven finding id means... or pastes a finding from a VibeRaven 1.5.3 report.' It also bounds scope with 'It does not read the user's repository, database or Vercel project.' No sibling tool is named as an alternative for the non-matching case, so it stops short of a full when/when-not/alternative triad.

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