Skip to main content
Glama

Health check

health
Read-only

Verify Vayl configuration and dependency reachability—database, embedder, LLM, and graph—to diagnose setup issues before relying on memory.

Instructions

Check that Vayl is configured and its dependencies are reachable — database, embedder, LLM, and graph (if enabled). Run this to diagnose setup before relying on memory; it makes one small LLM/embed call, so it costs a few tokens.

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

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.11.0

TDQS

A4.3/5.0
Behavior3/5

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

The annotations already cover the safety profile: readOnlyHint=true and openWorldHint=true. The description adds genuinely useful behavior the annotations do not: this health check makes one small LLM or embed call, so it costs a few tokens. That cost disclosure is real value, but it stops there and does not say what a failure looks like or how long it takes.

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?

Both sentences earn their place: the first scopes what is checked, the second explains when to run it and what it costs. The scope is stated up front and the wording carries no unnecessary text.

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?

Because an output schema exists, the description need not spell out return values, and it correctly leaves them out. For a zero-parameter diagnostic, it covers scope, the trigger for running it, and cost, so an agent has everything it needs.

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?

This tool takes zero parameters, so the schema has nothing to explain and takes no penalty for that. The baseline for a tool with no parameters is a 4, and nothing in the description adds or removes semantic meaning for parameters.

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?

A concrete verb ("Check") plus the exact set of resources verified: database, embedder, LLM, and graph (if enabled). This distinguishes it from adjacent read tools such as license_status or stats, which check different things.

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?

It states the triggering situation clearly: "Run this to diagnose setup before relying on memory." That is a real when-to-use rule. It does not name an explicit alternative or a when-not case, so it falls short of a 5.

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