Skip to main content
Glama

Configure vibe-check for a project

configure_project

Set or update .vibecheck.json to define quality review rules for your project. Use presets and per-dimension overrides to tune thresholds, budgets, and gates.

Instructions

Write or update .vibecheck.json in the project root.

Use preset to select a baseline posture - lenient for prototypes and spikes, balanced (default) for everyday application code, strict for production services and libraries - then override individual dimensions as needed. Thresholds are normalised 0-1 where 1 is always good. For the graded dimensions (readability, error_handling_present, test_coverage_adequate) the raw scale has four levels, so 0.33 means 'level 1 of 3' and 0.67 means 'level 2 of 3'. Judge credentials are never stored here: the API key is read from the server's environment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
judgeNo
budgetNo
presetNo
dry_runNoShow what would be written without writing it.
questionsNoPer-dimension overrides.
hard_gatesNo
conventionsNo
max_retriesNoMaximum submissions per task before escalating to the user. Default 3.
project_rootNoProject root. Defaults to the server's working directory.
reset_attemptsNoClear the retry budget for this project's tasks, or for a single task if task_description and changed_files are also given.
task_descriptionNoWith reset_attempts, narrows the reset to this one request instead of every request in the project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the transparency burden. It discloses the core side effect (writes/updates .vibecheck.json) and adds a useful behavioral note that judge credentials are never stored. Still, it does not say whether the file is fully overwritten or merged, whether existing settings are preserved, or what the tool returns after writing.

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?

The description is compact and front-loaded: it begins with the key action and file, then explains preset choices, threshold normalization, the graded scale, and credential handling. Each sentence adds value and there is no filler or repetition of schema details.

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

Completeness3/5

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

Given the tool's complexity (11 parameters, nested objects, no annotations, no output schema), the description covers the core concepts well but leaves several important options undocumented at the description level. There is also no mention of the return value or post-write effects, which creates a noticeable gap for an agent deciding how to use the result.

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 55%, so the description must compensate for the uncovered parameters. It does add real meaning for preset (lenient/balanced/strict), normalized thresholds, and the graded-dimension raw scale. But many nested parameters such as hard_gates, conventions, budget, and reset_attempts are not addressed in the description and rely on schema descriptions or inference.

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 first sentence is specific: it names the exact file (.vibecheck.json), the action (write or update), and the location (project root). It does not explicitly contrast with sibling tools, but the resource and action make the configuration-vs-review distinction clear.

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?

There is no explicit 'use this when...' or 'use for X, not Y' guidance. However, the description gives clear context and even maps presets to project types (prototypes, everyday code, production services), implying when each configuration choice is appropriate. No alternatives or exclusions are stated relative to submit_for_review or get_review_log.

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