Skip to main content
Glama

Set up Verbaly in a project

verbaly_init
Idempotent

Creates the config file and locale catalogs, detects the bundler or meta-framework, and names the package to add and line to wire. Keeps existing files, so re-running is safe.

Instructions

Create the config file and the locale catalogs, and detect the bundler or meta-framework so the answer names the package to add and the line to wire (what verbaly init does). A file already there is kept, never overwritten, so running it again is safe. Use it when verbaly_doctor finds no config; once the project is set up, verbaly_doctor is the one to run.

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_init"
  }
}

Input Schema

NameRequiredDescriptionDefault
dirNoDirectory for the catalogs (default: locales)
rootNoProject root holding verbaly.config (defaults to the server working directory)
localesNoEvery locale, source included
sourceLocaleNoThe language you write in (default: en)

Output Schema

NameRequiredDescriptionDefault
hostNoBundler or meta-framework detected from the dependencies
nextYesWhat a human still has to do, in order
foundNoCatalogs the project already had, which the new config points at
createdYesFiles written, relative to the project root
refusedYesLocales left out: not a locale tag, and no sure way to fix one
renamedYesLocales written with the hyphen a locale tag takes (pt_BR became pt-BR)
skippedYesFiles already there, left untouched
configFileYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare idempotency and non-destructiveness, but the description earns credit by explaining why: existing files are kept and never overwritten, so re-running is safe. It also describes the shape of the answer, naming the package to add and the line to wire, which annotations cannot convey.

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 front-loaded sentences covering action, safety and routing, each doing work. The parenthetical '(what `verbaly init` does)' is a small redundancy given the title already says setup, but nothing else is wasted.

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?

With an output schema present, return values need no explanation, and the description still usefully previews what the answer contains. Safety, idempotency and routing are all covered. The only gap is that a zero-required-parameter init tool says nothing about how the locale options affect what gets generated.

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 dir, root, locales and sourceLocale already carry defaults and meaning. The description adds nothing parameter-specific, such as how locales and sourceLocale interact or what happens when dir differs from the default. Baseline 3 applies.

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 specific verbs and resources: creates the config file and locale catalogs, and detects the bundler/meta-framework. It also distinguishes itself from the sibling it could be confused with by framing itself as the equivalent of `verbaly init`.

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?

Explicit routing: use it when verbaly_doctor finds no config, and once the project is set up, verbaly_doctor is the one to run. Both the when and the when-not are stated with the named alternative.

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