Skip to main content
Glama

Get checklist

get_checklist
Read-only

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 — and its 'request' when the item asks somebody for a document (a 📎 in its line): 'state' (waiting, overdue past its 'due' day, sent with a file not yet ticked, done once ticked) and the 'files' sent to it, or null for an item that asks for nothing. Needs only permission to see the issue.

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations already establish a safe read (readOnlyHint true, destructiveHint false). The description adds useful behavioral context beyond that: the permission needed ('only permission to see the issue') and the null/absent behavior for reminder, picture, and request. It does not discuss error cases, but it adds substantial context for a read 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?

The definition is front-loaded and contains no filler; every clause either defines an output field or states a permission constraint. The first sentence is a dense run-on with nested em dashes and parentheses, which weakens structure, but the length is justified by the complex return shape.

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?

With no output schema, the description must document the return shape, and it does: id, checked, text, depth, reminder, picture, request state, files, and null cases. It also states the permission boundary, leaving no major gap needed to invoke or interpret the result.

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?

There is only one parameter, 'key', and the schema fully documents it with an example ('UK-1'). The description adds no extra detail about key syntax, scoping, or lookup behavior, so the baseline of 3 is appropriate when the schema carries the parameter meaning.

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?

Starts with a specific verb and resource ('Read an issue's checklist') and defines exactly which description lines are parsed into items. It clearly separates the checklist view from the raw issue description and explains that returned ids feed check_checklist_item.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The read-before-check workflow is implied by the note that each id is passed to check_checklist_item. However, the description never explicitly says when to use this instead of get_issue, search_issues, or other sibling tools, and it gives no when-not conditions.

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