Skip to main content
Glama
Sign In
AIWorkhub

AIWorkhub

by shrec
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

roadmap_snapshot

Read-only

View roadmap outcomes with live linked-task statuses to identify done, blocked, and ready work in one read-only call.

Instructions

Return the Roadmap with each outcome joined to the live status of its linked tasks.

Measured: limit=60 replied 174 KB, 61% of it the outcome and acceptance bodies (NF-2026-01726). By default each row's outcome and acceptance fold to {summarized, bytes, length, sha256}; full=true or roadmap_show gives the full row.

Use this to see what is done, blocked or ready across the roadmap in one call. The other roadmap tools return stored fields only: roadmap_list the outcome rows, roadmap_show one outcome with its stored fields. Read-only.

The reply is aiworkhub.roadmap_snapshot.v1: total and active outcome counts, status_counts, items (up to limit outcome rows) and truncated. Each row is the stored outcome plus tasks (task id and live status, or missing / purged:<status> once the task record is gone), linked_total, accepted (finished tasks), unresolved (the rest), dependency_blockers and dependency_ready.

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

Input Schema

NameRequiredDescriptionDefault
fullNoReturn every outcome and acceptance body verbatim instead of folding each to its identity; default false.
limitNoMaximum outcome rows to return; default 200, clamped to 1-500. The reply's truncated flag says whether rows were left out.
include_archivedNoAlso include archived outcomes in the rows and counts; default false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.12.69
    • addedInput schema / properties / full
      Added value: +{
+  "default": false,
+  "description": "Return every outcome and acceptance body verbatim instead of folding each to its identity; default false.",
+  "title": "Full",
+  "type": "boolean"
+}
  2. Changed2 schema fields changedv0.12.67
    • addedInput schema / properties / include_archived / description
      Added value: +"Also include archived outcomes in the rows and counts; default false."
    • addedInput schema / properties / limit / description
      Added value: +"Maximum outcome rows to return; default 200, clamped to 1-500. The reply's truncated flag says whether rows were left out."
  3. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the bar is lower, but the description adds real operational context: a measured payload size (174 KB at limit=60, 61% bodies), the default folding of outcome/acceptance to identity hashes, and the truncation flag. It does not discuss auth or rate limits, which is a minor omission for a read-only tool.

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-loads the purpose, then usage, then reply shape, with no filler sentences. Slight redundancy from mentioning the full-row escape hatch twice (full=true and roadmap_show) and embedding a raw measurement, but each block earns its place.

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?

There is no output schema, and the description compensates fully by naming the response envelope (aiworkhub.roadmap_snapshot.v1) and every field an agent would need, including tasks, linked_total, accepted, unresolved, dependency_blockers, dependency_ready and truncated. An agent can interpret the result correctly on the first call.

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 documents full, limit and include_archived including defaults and the 1-500 clamp. The description's contribution is the empirical link between limit and reply size, which is useful but only marginal added meaning over structured data, so it sits at the baseline rather than above it.

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 ("Return the Roadmap") plus the key differentiator: each outcome joined to the live status of its linked tasks. The contrast with roadmap_list (stored outcome rows) and roadmap_show (one outcome, stored fields) lets an agent pick the right tool without opening any 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?

Gives an explicit use case ("see what is done, blocked or ready across the roadmap in one call") and names the two alternative roadmap tools with the condition that separates them. Routing is unambiguous.

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