Skip to main content
Glama
Sign In
AIWorkhub

AIWorkhub

by shrec
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

roadmap_list

Read-only

Lists repository roadmap outcomes with paging, status filters, and search, folding long outcome and acceptance bodies by default to keep responses compact; set full=true for verbatim rows.

Instructions

List bounded repository Roadmap outcomes; outcome and acceptance bodies fold to their identity.

Measured: the same rows roadmap_snapshot(limit=60) returned were 174 KB, 61% outcome and acceptance bodies (NF-2026-01726). By default both fold to {summarized, bytes, length, sha256}; full=true or roadmap_show gives the full row.

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_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
fullNoReturn every outcome and acceptance body verbatim instead of folding each to its identity; default false.
limitNoMaximum outcomes to return; default 100, clamped to 1-500.
queryNoCase-insensitive substring of the id or title, applied before limit/offset; empty (default) lists everything.
offsetNoNumber of outcomes to skip, for paging; default 0.
statusNoOnly outcomes in this status: proposed, approved, in_progress, blocked, deferred, completed or archived. Omit to list every non-archived outcome.
include_archivedNoWith no status filter, also return archived outcomes; default false.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.12.98
    • addedInput schema / properties / query
      Added value: +{
+  "default": "",
+  "description": "Case-insensitive substring of the id or title, applied before limit/offset; empty (default) lists everything.",
+  "title": "Query",
+  "type": "string"
+}
  2. 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"
+}
  3. Changed4 schema fields changedv0.12.67
    • addedInput schema / properties / include_archived / description
      Added value: +"With no status filter, also return archived outcomes; default false."
    • addedInput schema / properties / limit / description
      Added value: +"Maximum outcomes to return; default 100, clamped to 1-500."
    • addedInput schema / properties / offset / description
      Added value: +"Number of outcomes to skip, for paging; default 0."
    • addedInput schema / properties / status / description
      Added value: +"Only outcomes in this status: proposed, approved, in_progress, blocked, deferred, completed or archived. Omit to list every non-archived outcome."
  4. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/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 adds genuinely useful behavior beyond that: concrete payload measurements (174 KB, 61% bodies) and the folding contract {summarized, bytes, length, sha256}, which tells the agent what is lost by default.

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?

Two short paragraphs, front-loaded with the operation and its default folding behavior. The measurement figures are dense but earn their place as justification for the default; the phrase 'bounded repository Roadmap outcomes' is slightly opaque jargon.

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?

An output schema exists, so return shape needn't be described, and all six parameters are schema-documented. The behavioral story (size, folding, escape hatch) is complete; only the relationship to roadmap_snapshot as an alternative listing path is left unstated.

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 every parameter is already documented in the schema, establishing a baseline of 3. The description reinforces the meaning of full=true (verbatim vs. folded) with a rationale, but adds no new syntax or constraint beyond what the schema states.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource -- list Roadmap outcomes -- and immediately clarifies the key output shape: outcome and acceptance bodies are folded to their identity. It distinguishes itself from roadmap_show by naming it as the path to full rows, though the boundary against roadmap_snapshot is only implied.

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?

Explicitly routes the agent: leave the default for compact rows, use full=true or roadmap_show when verbatim bodies are needed. No when-not-to-use guidance against roadmap_snapshot, which is the closest sibling by name.

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