Skip to main content
Glama

Check setup

doctor
Read-only

Verifies the agent binary, project config, and detected test command, and can ping the agent with a one-word prompt to confirm readiness before test delegation.

Instructions

Checks the agent binary, the project config and the detected test command. ping=true also sends the agent a one-word prompt.

Input Schema

NameRequiredDescriptionDefault
pingNo
projectRootNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

B3/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes that this is a safe read-style check, so the description does not need to prove that. It adds useful behavior by naming the checked components and disclosing that ping=true sends the agent a one-word prompt, but it omits return behavior and error/failure semantics.

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?

The description is two tight sentences with no filler. The core diagnostic purpose is front-loaded, and the optional ping behavior is clearly appended.

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

Completeness2/5

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

There is no output schema, so the description should explain what a successful or failed check returns. It also leaves projectRoot undocumented, making the definition incomplete for correct invocation despite its concise clarity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate for both parameters. It partially explains ping=true, but never defines ping=false/default behavior or the purpose of projectRoot.

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 description states a specific action and concrete resources: checking the agent binary, project config, and detected test command. It clearly is not a task-management operation like the sibling tools, though it does not explicitly contrast itself with them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

The description explains what is checked but gives no explicit when-to-use guidance, prerequisites, or alternatives. An agent can infer it is a setup diagnostic, but the description does not say when to call it instead of task-status or delegation tools.

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