Skip to main content
Glama

List Workstreams

workstreams
Read-onlyIdempotent

List high-level workstreams for a project, optionally filtered by status, returning progress, next actions, and blockers as JSON.

Instructions

Read-only. List existing high-level workstreams for a required project, optionally filtered by status=active, paused, completed, or abandoned. Returns a JSON array with each workstream's status, progress, next action, blockers, and timestamps. Use update_workstream to mutate an existing row; this tool does not create, update, or delete workstreams. A missing project or database failure returns a tool error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYesStatus filter: active, paused, completed, abandoned
projectNoProject name filter

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
workstreamsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.6.93
    • addedOutput schema / $defs / WorkstreamOutput / properties / display_label
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / $defs / WorkstreamOutput / properties / mmdd
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / $defs / WorkstreamOutput / properties / session_intent
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / $defs / WorkstreamOutput / properties / session_intent_source
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / $defs / WorkstreamOutput / properties / session_topic
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedOutput schema / $defs / WorkstreamOutput / required
      Previous value: -[
      -  "id",
      -  "project",
      -  "title",
      -  "status",
      -  "created_at_epoch",
      -  "updated_at_epoch"
      -]New value: +[
      +  "id",
      +  "project",
      +  "title",
      +  "status",
      +  "created_at_epoch",
      +  "updated_at_epoch",
      +  "mmdd",
      +  "session_intent",
      +  "session_topic",
      +  "display_label",
      +  "session_intent_source"
      +]
  2. Changed3 schema fields changedv0.6.45
    • addedInput schema / properties / status / enum
      Added value: +[
      +  "active",
      +  "paused",
      +  "completed",
      +  "abandoned"
      +]
    • addedInput schema / required
      Added value: +[
      +  "status"
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "WorkstreamOutput": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "blockers": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "completed_at_epoch": {
      +          "format": "int64",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "created_at_epoch": {
      +          "format": "int64",
      +          "type": "integer"
      +        },
      +        "description": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "id": {
      +          "format": "int64",
      +          "type": "integer"
      +        },
      +        "next_action": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "progress": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "project": {
      +          "type": "string"
      +        },
      +        "status": {
      +          "$ref": "#/$defs/WorkstreamStatus"
      +        },
      +        "title": {
      +          "type": "string"
      +        },
      +        "updated_at_epoch": {
      +          "format": "int64",
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "project",
      +        "title",
      +        "status",
      +        "created_at_epoch",
      +        "updated_at_epoch"
      +      ],
      +      "type": "object"
      +    },
      +    "WorkstreamStatus": {
      +      "enum": [
      +        "active",
      +        "paused",
      +        "completed",
      +        "abandoned"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": false,
      +  "properties": {
      +    "workstreams": {
      +      "items": {
      +        "$ref": "#/$defs/WorkstreamOutput"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "workstreams"
      +  ],
      +  "title": "WorkstreamsOutput",
      +  "type": "object"
      +}
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already provide readOnlyHint, idempotentHint, and destructiveHint=false, and the description reinforces 'Read-only' consistently. It adds useful behavioral detail beyond the annotations: the JSON array return shape, the per-workstream fields, and the missing-project/database-failure error behavior. The error claim is slightly undercut by the schema making project optional, but the transparency effort is strong.

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 concise and well-structured. The read-only nature and primary verb are front-loaded, followed by the filter options, return shape, and an explicit alternative. Every sentence earns its place without 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?

For a simple list tool, the description is nearly complete: it covers purpose, filters, returns, error cases, and the mutation alternative. The output schema covers the return contract. The only notable gap is the contradictory guidance about required versus optional parameters, which prevents a perfect completeness score.

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

Parameters2/5

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

Schema description coverage is 100%, so the baseline for parameter semantics is 3. However, the description actively conflicts with the schema: it says 'required project' and 'optionally filtered by status', while the schema marks status as required and project as nullable. This inversion makes it risky for an agent to decide which parameters to supply.

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?

The description clearly identifies the operation: 'List existing high-level workstreams' and distinguishes this tool from update_workstream by explicitly stating it 'does not create, update, or delete workstreams'. However, calling project 'required' while the schema lists status as required and project as nullable creates ambiguity about the tool's exact scope.

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?

The description gives explicit usage guidance: use it to list workstreams with an optional status filter, and use update_workstream to mutate an existing row. It also explicitly states what this tool does not do, which helps an agent choose between siblings. Error behavior is also disclosed.

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