Skip to main content
Glama

list_programmes

Retrieve and filter programmes by status or candidate version, with pagination, to enumerate a candidate's descendants and review programme records across all statuses.

Instructions

List programmes with optional attribution/status filters (read-only).

candidate_version_id filters to programmes created under that candidate (the RSI Phase-0 correlation) — this is how a candidate's descendants are enumerated. Each row includes candidate_version_id. Unlike list_active_programmes this is a paginated general listing across all statuses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax rows to return (pagination).
offsetNoRows to skip before returning (pagination).
statusNoOptional status filter.
candidate_version_idNoRSI Phase-0 correlation — which registered candidate created this programme; must exist if given.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
totalNo
programmesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.28

TDQS

A4.1/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses the read-only nature and pagination, plus that each row includes candidate_version_id, which is useful. However, it omits auth requirements, rate limits, and other operational traits expected when no annotation coverage exists.

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 core purpose, then elaborates on the correlation filter and sibling differentiation. Well-sized and mostly waste-free, though the multi-line phrasing is slightly verbose.

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 read-only, paginated listing tool with full schema coverage and an output schema, the description covers purpose, filters, and sibling differentiation adequately, so return values need not be explained. Minor gaps in operational context remain but nothing essential is missing.

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% (baseline 3), but the description adds genuine meaning beyond the schema by explaining candidate_version_id as the 'RSI Phase-0 correlation' and the mechanism for enumerating a candidate's descendants, plus clarifying status filtering.

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 ('List programmes') with scope ('optional attribution/status filters') and explicitly distinguishes itself from the sibling list_active_programmes ('a paginated general listing across all statuses'). An agent can tell it apart without opening either schema.

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?

Names the alternative (list_active_programmes) and the condition selecting it (all statuses vs. active only), and explains the candidate_version_id use case for enumerating a candidate's descendants. Context is clear, though it doesn't spell out explicit when-not-to-use cases.

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