Skip to main content
Glama

Diagnose the setup

verbaly_doctor
Read-only

Diagnose a Verbaly project end to end and report config, catalog, plugin, type, parser, orphan-key, and check failures together, not one at a time. Run it first when something breaks.

Instructions

Diagnose a Verbaly project end to end (what verbaly doctor does). It checks the config file, the catalogs and their JSON, the bundler plugin for the detected framework, the generated types, files the parser could not read, a t imported from a package that never exports it, orphan keys, and every failure verbaly check would report, and it reports them all at once instead of stopping at the first. Run it first when something does not work. Read-only. For the missing or broken translations themselves, use verbaly_missing.

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": "verbaly_doctor"
  }
}

Input Schema

NameRequiredDescriptionDefault
rootNoProject root holding verbaly.config (defaults to the server working directory)

Output Schema

NameRequiredDescriptionDefault
okYesFalse when an entry is an error, which is when the CLI exits 1
entriesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so 'Read-only' is largely a restatement. What the description does add is genuinely useful: it accumulates all failures at once rather than stopping at the first, and it spells out the exact check surface. With annotations carrying the safety profile and an output schema carrying the result shape, this is useful but not rich enough to reach 4.

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?

It is front-loaded with the purpose, then the check list, then the routing to the sibling, which is the right order. The long enumeration is dense but every clause names a distinct failure class, so little can be cut without losing signal; the only waste is restating 'Read-only' already present in annotations.

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?

A read-only diagnostic with one optional parameter, full schema coverage, and an output schema has no remaining explanation burden, and the description still covers failure semantics and sibling routing. An agent can call this correctly from the description alone.

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?

The single parameter has 100% schema description coverage and already explains the default working directory, so the schema does the work. The description never mentions 'root' and adds no syntax, format, or edge-case meaning beyond it, which is the expected baseline when coverage is complete.

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?

The description names a specific verb and resource ('Diagnose a Verbaly project end to end') and then enumerates concrete checks: config file, catalogs and their JSON, bundler plugin, generated types, unparsable files, phantom package imports, orphan keys. It also distinguishes itself from the sibling that handles the actual translation gaps ('use verbaly_missing'), so an agent can separate it from verbaly_status or verbaly_missing 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 Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives an explicit trigger ('Run it first when something does not work') and an explicit routing rule to an alternative ('For the missing or broken translations themselves, use verbaly_missing'). Both the when-to-use and the when-to-use-something-else cases are covered, leaving little to inference.

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