Skip to main content
Glama

get_checklist

Read an issue's checklist — the '- [ ]' lines of its description — as items, in order: each with a stable 'id' (pass it to check_checklist_item), 'checked', its words ('text', without reminder or picture), its 'depth' when nested, its 'reminder' ('YYYY-MM-DD HH:MM' or null) and its 'picture' — the attachment it shows of how the item should look, with the 'content' address its bytes are read at with this same token, or null. Needs only permission to see the issue.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesIssue key, e.g. 'UK-1'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

No annotations are provided, so the description carries the burden and does well: it discloses the required permission ('permission to see the issue'), the stable id for follow-up mutation, and the auth requirement for the picture content ('with this same token'). It doesn't cover pagination or failure modes, but for a read it is substantive.

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?

Dense but front-loaded: the core action and resource come first, then the field inventory. The long run-on enumeration sacrifices some readability but every clause carries information.

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?

For a single-param read with no output schema, the description fully defines the return object (id, checked, text, depth, reminder, picture, content), the permission requirement, and the follow-up tool. Nothing an agent needs to call or consume it correctly is missing.

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 coverage is 100%, and the sole parameter 'key' is fully documented in the schema ('Issue key, e.g. UK-1.'). The description adds no param-level meaning, so baseline 3 applies.

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 ('Read') and resource ('an issue's checklist — the '- [ ]' lines of its description') and distinguishes itself clearly from the sibling check_checklist_item, which it explicitly routes to. An agent can tell exactly what this returns.

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?

The description implies when to use it: to read checklist items and get the 'id' needed for check_checklist_item. The reference to check_checklist_item provides a clear handoff, but there is no explicit when-not or alternative for reading checklist content.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources