Skip to main content
Glama

Get operational health

get_health
Read-only

Check Markdown vault health with read-only diagnostics on index freshness, integrity, checksums, durability, and invariants. Use full detail for bounded integrity findings.

Instructions

Return truthful read-only health for index freshness, vault integrity, point-in-time checksum, durability capability, and invariant evidence. Use detail='full' to include bounded integrity findings. In full mode, limit <= 0 selects the server ceiling and positive limits are capped by settings.max_result_count. Fingerprints are opaque baseline identifiers derived from raw keys, not hashes of sanitized published keys. Only top-level violation rel_path and mixed_eol_notes entries preserve addressable paths; details such as candidate_paths are sanitized display metadata. Findings do not include line numbers.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
detailNosummary

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexYes
statusYes
guidanceYes
recoveryYes
scrubberYes
integrityYes
read_onlyYes
durabilityYes
invariantsYes
server_versionYes
vault_checksumYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.15
    • addedOutput schema / $defs / HealthRecoveryOutput / properties / unexpected_entries
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "title": "Unexpected Entries",
      +  "type": "array"
      +}
    • changedOutput schema / $defs / HealthRecoveryOutput / required
      Previous value: -[
      -  "required",
      -  "blocked_operations",
      -  "operations"
      -]New value: +[
      +  "required",
      +  "blocked_operations",
      +  "unexpected_entries",
      +  "operations"
      +]
  2. Changed2 schema fields changedv0.1.11
    • addedOutput schema / properties / guidance
      Added value: +{
      +  "items": {
      +    "additionalProperties": {
      +      "type": "string"
      +    },
      +    "type": "object"
      +  },
      +  "title": "Guidance",
      +  "type": "array"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "status",
      -  "server_version",
      -  "read_only",
      -  "index",
      -  "integrity",
      -  "vault_checksum",
      -  "durability",
      -  "recovery",
      -  "scrubber",
      -  "invariants"
      -]New value: +[
      +  "status",
      +  "server_version",
      +  "read_only",
      +  "index",
      +  "integrity",
      +  "vault_checksum",
      +  "durability",
      +  "recovery",
      +  "scrubber",
      +  "invariants",
      +  "guidance"
      +]
  3. Changed14 schema fields changedv0.1.3
    • addedInput schema / properties / detail
      Added value: +{
      +  "default": "summary",
      +  "enum": [
      +    "summary",
      +    "full"
      +  ],
      +  "title": "Detail",
      +  "type": "string"
      +}
    • addedInput schema / properties / limit
      Added value: +{
      +  "default": 0,
      +  "title": "Limit",
      +  "type": "integer"
      +}
    • addedOutput schema / $defs / HealthFindingsOutput
      Added value: +{
      +  "description": "Bounded detailed reliability findings.",
      +  "properties": {
      +    "flagged_paths": {
      +      "$ref": "#/$defs/HealthFlaggedPathsOutput"
      +    },
      +    "limit_applied": {
      +      "title": "Limit Applied",
      +      "type": "integer"
      +    },
      +    "returned": {
      +      "title": "Returned",
      +      "type": "integer"
      +    },
      +    "total": {
      +      "title": "Total",
      +      "type": "integer"
      +    },
      +    "truncated": {
      +      "title": "Truncated",
      +      "type": "boolean"
      +    },
      +    "violations": {
      +      "items": {
      +        "$ref": "#/$defs/HealthViolationOutput"
      +      },
      +      "title": "Violations",
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "violations",
      +    "flagged_paths",
      +    "total",
      +    "returned",
      +    "limit_applied",
      +    "truncated"
      +  ],
      +  "title": "HealthFindingsOutput",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / HealthFlaggedPathsOutput
      Added value: +{
      +  "description": "Raw mixed-EOL paths and sanitized read, decode, or frontmatter error descriptions.",
      +  "properties": {
      +    "frontmatter_parse_errors": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "title": "Frontmatter Parse Errors",
      +      "type": "array"
      +    },
      +    "mixed_eol_notes": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "title": "Mixed Eol Notes",
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "mixed_eol_notes",
      +    "frontmatter_parse_errors"
      +  ],
      +  "title": "HealthFlaggedPathsOutput",
      +  "type": "object"
      +}
    • changedOutput schema / $defs / HealthIntegrityOutput / description
      Previous value: -"Vault integrity counters included in operational health."New value: +"Vault integrity counters and optional detailed findings."
    • addedOutput schema / $defs / HealthIntegrityOutput / properties / broken_wikilinks_misdirected
      Added value: +{
      +  "title": "Broken Wikilinks Misdirected",
      +  "type": "integer"
      +}
    • addedOutput schema / $defs / HealthIntegrityOutput / properties / detail
      Added value: +{
      +  "enum": [
      +    "summary",
      +    "full"
      +  ],
      +  "title": "Detail",
      +  "type": "string"
      +}
    • addedOutput schema / $defs / HealthIntegrityOutput / properties / findings
      Added value: +{
      +  "$ref": "#/$defs/HealthFindingsOutput"
      +}
    • changedOutput schema / $defs / HealthIntegrityOutput / required
      Previous value: -[
      -  "notes_count",
      -  "id_mismatches",
      -  "broken_wikilinks",
      -  "mixed_eol_notes",
      -  "supersedes_cycles",
      -  "frontmatter_parse_errors"
      -]New value: +[
      +  "notes_count",
      +  "id_mismatches",
      +  "broken_wikilinks",
      +  "broken_wikilinks_misdirected",
      +  "mixed_eol_notes",
      +  "supersedes_cycles",
      +  "frontmatter_parse_errors",
      +  "detail"
      +]
    • addedOutput schema / $defs / HealthRecoveryOperationOutput
      Added value: +{
      +  "description": "Content-free evidence for one operation that requires explicit repair.",
      +  "properties": {
      +    "disk_hash": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "title": "Disk Hash"
      +    },
      +    "expected_after_hash": {
      +      "title": "Expected After Hash",
      +      "type": "string"
      +    },
      +    "expected_before_hash": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "title": "Expected Before Hash"
      +    },
      +    "operation_id": {
      +      "title": "Operation Id",
      +      "type": "string"
      +    },
      +    "reason": {
      +      "title": "Reason",
      +      "type": "string"
      +    },
      +    "rel_path": {
      +      "title": "Rel Path",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "operation_id",
      +    "rel_path",
      +    "reason",
      +    "expected_before_hash",
      +    "expected_after_hash",
      +    "disk_hash"
      +  ],
      +  "title": "HealthRecoveryOperationOutput",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / HealthRecoveryOutput
      Added value: +{
      +  "description": "Bounded recovery evidence included in operational health.",
      +  "properties": {
      +    "blocked_operations": {
      +      "title": "Blocked Operations",
      +      "type": "integer"
      +    },
      +    "operations": {
      +      "items": {
      +        "$ref": "#/$defs/HealthRecoveryOperationOutput"
      +      },
      +      "title": "Operations",
      +      "type": "array"
      +    },
      +    "required": {
      +      "title": "Required",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "required",
      +    "blocked_operations",
      +    "operations"
      +  ],
      +  "title": "HealthRecoveryOutput",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / HealthViolationOutput
      Added value: +{
      +  "description": "One finding with an addressable path and an opaque baseline fingerprint.",
      +  "properties": {
      +    "classification": {
      +      "title": "Classification",
      +      "type": "string"
      +    },
      +    "details": {
      +      "additionalProperties": {
      +        "type": "string"
      +      },
      +      "title": "Details",
      +      "type": "object"
      +    },
      +    "fingerprint": {
      +      "title": "Fingerprint",
      +      "type": "string"
      +    },
      +    "key": {
      +      "title": "Key",
      +      "type": "string"
      +    },
      +    "kind": {
      +      "title": "Kind",
      +      "type": "string"
      +    },
      +    "rel_path": {
      +      "title": "Rel Path",
      +      "type": "string"
      +    },
      +    "target": {
      +      "title": "Target",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "kind",
      +    "key",
      +    "fingerprint",
      +    "rel_path"
      +  ],
      +  "title": "HealthViolationOutput",
      +  "type": "object"
      +}
    • addedOutput schema / properties / recovery
      Added value: +{
      +  "$ref": "#/$defs/HealthRecoveryOutput"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "status",
      -  "server_version",
      -  "read_only",
      -  "index",
      -  "integrity",
      -  "vault_checksum",
      -  "durability",
      -  "scrubber",
      -  "invariants"
      -]New value: +[
      +  "status",
      +  "server_version",
      +  "read_only",
      +  "index",
      +  "integrity",
      +  "vault_checksum",
      +  "durability",
      +  "recovery",
      +  "scrubber",
      +  "invariants"
      +]
  4. First observedv0.1.0

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, but the description goes far beyond that. It explains the 'truthful read-only' nature, how limit works in full mode (server ceiling vs capped by settings.max_result_count), fingerprint semantics (opaque baseline identifiers from raw keys, not hashes of sanitized keys), path preservation (only top-level violation rel_path and mixed_eol_notes preserve addressable paths), and that findings omit line numbers. These are detailed behavioral traits that the annotations do not convey, so the description adds substantial value.

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?

The description is dense but every sentence contributes: purpose, usage detail, limit semantics, fingerprint clarification, path preservation caveat, and line number note. It is front-loaded with the core purpose before diving into specifics. It is somewhat long but all content is relevant and non-redundant, so a 4 is appropriate.

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?

Given the tool's complexity (multiple health dimensions, parameter interactions, output schema present), the description covers the essential operational details: how to request full findings, limit behavior, fingerprint definition, path addressability, and missing line numbers. The output schema likely defines return values, so the description need not repeat them. Nothing an agent needs to correctly call the tool is missing, so this is complete.

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 0%, so the description must compensate. It does explain both parameters: detail (with enum values summary/full) is described as 'summary' default and 'full' to include bounded integrity findings; limit is explained in full mode with specific behavior (<=0 selects server ceiling, positive limits capped by settings.max_result_count). This adds meaningful semantics beyond the bare schema, though it could be slightly more explicit about summary mode and limit's default behavior outside full mode, hence a 4 rather than 5.

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 states a specific verb and resource: 'Return truthful read-only health' for several named aspects (index freshness, vault integrity, point-in-time checksum, durability capability, invariant evidence). This clearly distinguishes it from all sibling tools, which are note operations, search, and other non-health functions. The purpose is unambiguous and specific.

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

Usage Guidelines3/5

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

The description provides usage details (e.g., 'Use detail=\'full\' to include bounded integrity findings', limit behavior) but does not explicitly state when to use this tool versus alternatives or when not to use it. Since it is a unique health-check tool among siblings, the need for alternatives is low, but the description lacks an explicit usage context or exclusion statement, so it earns a mid score.

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