Skip to main content
Glama
Sign In
AIWorkhub

AIWorkhub

by shrec
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

aiworkhub_dashboard_snapshot

Read-only

Builds a read-only snapshot of the active repository's dashboard queue, health, and storage state from canonical SQLite data, returning a compact summary or full payload for status counts and manager queue views.

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 the cheap connection-check view or the single task-card detail view instead. Reads canonical SQLite state and cached storage telemetry without mutating tasks or launching processes.

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

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.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered; the description reinforces it and adds real context about which state is read (canonical SQLite state, cached storage telemetry) and that no tasks are mutated and no processes launched. It does not describe cost/latency behavior for full mode beyond the schema's contract-digest note.

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?

Front-loaded with the READ-ONLY marker and the core capability, then mode guidance, then data-source caveats — good ordering with no filler sentences. The closing clause 'without mutating tasks or launching processes' partially restates the READ-ONLY marker, a small redundancy.

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

Completeness4/5

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

Four optional parameters are fully documented in the schema and an output schema exists, so return values need no explanation. The description covers modes and the non-mutating guarantee; the only minor gap is that it never explains how the 'active repository' is determined, given there is no repository parameter.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already explains full, previous, previous_snapshot, and known_contract_sha256. The description adds only the consumer framing for full vs compact; it says nothing about the two 'previous' aliases or the contract digest, so it does not go meaningfully 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 states a specific verb and composite resource: 'build the canonical dashboard queue, health, and storage snapshot for the active repository.' The three constituents (queue, health, storage) and the scope (active repository) let an agent distinguish this from siblings like aiworkhub_task_health or aiworkhub_dispatcher_health, which cover only one slice.

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 gives explicit mode-selection guidance: default compact for manager queue summaries and status counts, full=True for the native Webview payload. It also redirects two other cases elsewhere, but refers to them only as 'the cheap connection-check view' and 'the single task-card detail view' rather than naming the actual sibling tools, so the agent must still guess the target.

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