Skip to main content
Glama

aiworkhub_dashboard_snapshot

Read-only

Build a read-only snapshot of the active repository's dashboard queue, health, and storage; choose compact summaries or full Webview payloads without mutating tasks.

Instructions

READ-ONLY: build the canonical dashboard queue, health, and storage snapshot for the active repository.

Use the default compact mode for manager queue summaries and status counts, or full=True for the native Webview payload; use aiworkhub_dashboard_health for a cheap connection check or aiworkhub_dashboard_task_detail for one task card. Reads canonical SQLite state and cached storage telemetry without mutating tasks or launching processes.

Input Schema

NameRequiredDescriptionDefault
fullNobool (default False); True returns full task, process, and ledger collections, False returns the compact summary.
previousNooptional Mapping[str, Any] (default None) prior snapshot dict reused for incremental diffing.
previous_snapshotNooptional Mapping[str, Any] (default None) alias for previous when previous is omitted.
known_contract_sha256Nostr (default "") contract SHA-256 digest the caller already holds; compact mode omits the contract prose by default and re-sends it only when this digest differs from the current contract_sha256.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.12.64
    • changedInput schema / properties / known_contract_sha256 / description
      Previous value: -"str (default \"\") manager contract SHA-256 digest; omits unchanged contract prose in compact mode."New value: +"str (default \"\") contract SHA-256 digest the caller already holds; compact mode omits the contract prose by default and re-sends it only when this digest differs from the current contract_sha256."
  2. Changed4 schema fields changedv0.12.62
    • addedInput schema / properties / full / description
      Added value: +"bool (default False); True returns full task, process, and ledger collections, False returns the compact summary."
    • addedInput schema / properties / known_contract_sha256 / description
      Added value: +"str (default \"\") manager contract SHA-256 digest; omits unchanged contract prose in compact mode."
    • addedInput schema / properties / previous / description
      Added value: +"optional Mapping[str, Any] (default None) prior snapshot dict reused for incremental diffing."
    • addedInput schema / properties / previous_snapshot / description
      Added value: +"optional Mapping[str, Any] (default None) alias for previous when previous is omitted."
  3. First observedv0.1.0

TDQS

A4.7/5.0
Behavior4/5

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

The readOnlyHint annotation already signals safety, but the description adds useful behavioral context: it reads canonical SQLite state and cached storage telemetry, and it does not mutate tasks or launch processes. It does not discuss performance characteristics or caching behavior beyond the data sources, but the safety boundary is clearly reinforced.

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 front-loaded with the READ-ONLY constraint, then gives mode guidance and alternatives in three efficient sentences. Every sentence contributes either scope, routing, or behavioral context with no waste.

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 available output schema, full parameter descriptions, and read-only annotation, the description supplies enough context to select and invoke the tool correctly. It covers purpose, mode selection, alternatives, data sources, and non-mutation behavior without needing to duplicate return-value details.

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 the baseline is 3. The description adds meaningful use-case semantics for the full parameter by contrasting compact manager summaries/status counts with the full native Webview payload, though it does not elaborate on the previous/previous_snapshot or known_contract_sha256 parameters beyond the schema.

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 uses a specific verb and resource: it builds the canonical dashboard queue, health, and storage snapshot for the active repository. It also distinguishes itself from related tools like dashboard_health and dashboard_task_detail, so an agent can select it without inspecting the schema.

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?

It explicitly states when to use the default compact mode versus full=True, including the intended use case for each. It also names alternatives for a cheap connection check and for a single task card, making the routing decision clear.

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

Deploy Server

Other Tools