Skip to main content
Glama

Unified setup diagnose

diagnose_setup
Read-onlyIdempotent

Check Mushi-Mushi setup health and return one recommended next action; run ingest, dispatch, or full preflight checks to identify missing setup steps.

Instructions

Diagnose Mushi setup health and return the single best next action. mode=full (default) runs both SDK-ingest and fix-dispatch preflight checks; mode=ingest runs ingest checks only (project exists, active API key, SDK heartbeat, at least one report); mode=dispatch runs dispatch readiness only (GitHub connected, codebase indexed, LLM key present, autofix enabled). Returns { ready, steps: [{ label, complete, required, hint }], nextAction }. Read-only. The one setup-diagnosis entry point — use this instead of separate connection/ingest checks.

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

Input Schema

NameRequiredDescriptionDefault
modeNofull (default) = ingest + dispatch; ingest = SDK pipeline only; dispatch = fix preflight only.
projectIdNoProject UUID for dispatch checks (defaults to configured project). (`project_id` is accepted too.)

Output Schema

NameRequiredDescriptionDefault
modeYes
readyYes
healthNo
ingestNo
summaryYes
dispatchNo
connectionNo
nextActionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.20
    • addedOutput schema / properties / health
      Added value: +{}
  2. Changed3 schema fields changedv0.1.12
    • changedInput schema / properties / projectId / description
      Previous value: -"Alias for project_id."New value: +"Project UUID for dispatch checks (defaults to configured project). (`project_id` is accepted too.)"
    • removedInput schema / properties / project_id
      Removed value: -{
      -  "description": "Project UUID for dispatch checks (defaults to configured project).",
      -  "type": "string"
      -}
    • addedOutput schema / properties / mode / enum
      Added value: +[
      +  "full",
      +  "ingest",
      +  "dispatch"
      +]
  3. Changed2 schema fields changedv0.1.10
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  4. Changed1 schema field changedv0.1.2
    • addedOutput schema / properties / connection
      Added value: +{}
  5. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint, so the "Read-only" line is redundant. What the description adds beyond the structured fields is the concrete checklist each mode inspects (project exists, active API key, SDK heartbeat, GitHub connected, codebase indexed, LLM key, autofix enabled), which tells an agent what a negative result actually means.

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?

Purpose and the routing rule are front-loaded, then modes, then return shape. It is dense with parenthetical lists, and the return-shape sentence partly duplicates the output schema, but nearly every clause carries selection-relevant information.

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?

For a two-parameter read-only diagnostic with a published output schema and full annotation coverage, the description supplies everything needed: what is checked per mode, what the result conveys, and where the tool sits relative to alternatives. Nothing material is missing.

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?

Schema coverage is 100%, so both parameters and the mode enum are already documented; baseline would be 3. The description earns above baseline by mapping each mode value to the specific checks it triggers, which the schema does not convey.

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 a specific verb and resource ("Diagnose Mushi setup health") plus the distinctive output ("the single best next action"). It explicitly claims the role of "the one setup-diagnosis entry point — use this instead of separate connection/ingest checks," which separates it from siblings like get_two_way_comms_health or check_sdk_version.

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?

Enumerates the three modes and the exact condition selecting each (full = both, ingest = SDK pipeline only, dispatch = fix preflight only). It also states the exclusion: don't run separate connection/ingest checks, use this instead.

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