Skip to main content
Glama

Archive or unarchive checklist

set_checklist_archived
Idempotent

Archive a checklist, or take it back out of the archive. An archived checklist is left out of the checklist list unless includeArchived is true, and out of the tasks grid, the analytics and its template's listings; its tasks, comments and field values stay exactly where they are. Workspace administrators only -- archiving makes a checklist disappear for everyone, so unlike renaming or completing it is not gated on the per-checklist run permission, and a connection acting for no particular member is refused. Asking for the state it is already in succeeds and changes nothing.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "checklistKey": "<checklistKey>",
      "isArchived": "<isArchived>"
    },
    "name": "set_checklist_archived"
  }
}

Input Schema

NameRequiredDescriptionDefault
isArchivedYesTrue to archive it, false to bring it back.
checklistKeyYesThe checklist's key, a GUID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the annotations (idempotentHint, destructiveHint=false), it discloses the real behavioral contract: tasks, comments and field values are preserved, the action is workspace-admin-only and explicitly not gated on the per-checklist run permission, unauthenticated connection-level calls are refused, and repeating the current state succeeds as a no-op. That is exactly the mutation-side context an agent needs before calling.

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?

A single dense paragraph with the primary action first, then visibility effects, then permissions, then idempotency — well front-loaded and free of filler. It is on the longer side, but nearly every clause carries distinct operational 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 two-parameter, non-destructive toggle with no output schema, the description covers the effect on related surfaces, authorization requirements, data preservation, and idempotent behavior. Nothing an agent would need before invoking 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 both parameters are fully documented in the schema, so the description adds little parameter-level meaning. The one parameter-adjacent mention, includeArchived, refers to the listing tools rather than either of this tool's own arguments, so it does not enrich isArchived or checklistKey beyond what the schema already says.

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?

The opening sentence names a specific verb (archive) and a reversible counterpart on a specific resource (checklist), so it is instantly distinguishable from set_template_archived and delete_checklist in the sibling list. The two-direction behavior is stated up front rather than inferred.

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?

It gives a clear usage context: it describes exactly where an archived checklist disappears from and notes the workspace-administrator requirement and the refusal case for connection-level auth. What it does not do is name an alternative (e.g. delete_checklist for permanent removal, or set_template_archived for templates), so an agent still has to infer the choice between archiving and deleting.

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.