Skip to main content
Glama

restore_project

Restore an archived project so its tasks resume, recording the reason in the project's case. Only main tokens can restore; non-archived projects are refused.

Instructions

Brings an archived project back: files a restored entry carrying the reason in its case, and its tasks resume where the archive left them. Only a main token restores.

A project that is not archived is refused with project_not_archived.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYesProject key, case-insensitive. An unknown key is refused with `project_not_found`
reasonYesWhy the project is archived or restored; a blank one is refused with `project_reason_required`. Filed in the `archived` or `restored` entry of the project's case

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noYesNumber of the `archived` or `restored` entry in the project's case
keyYes
archived_atYesWhen the project was archived; `null` once it is restored

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.5.2

TDQS

A4.2/5.0
Behavior4/5

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

Annotations indicate a write operation (readOnlyHint=false) but not destructive (destructiveHint=false). The description adds behavior beyond that: filing a 'restored' entry with the reason, resuming tasks, and the token restriction. No contradiction with annotations found.

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?

Two short, dense paragraphs. The primary action and effect are in the first sentence, with a token restriction and an error condition in the second. No filler or redundancy; every line carries information.

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 tool with two required params, an output schema, and annotations, the description covers the core behavior, side effects, a permission restriction, and a common error. It does not describe return values, but the output schema exists. Minor gap: it doesn't address what happens if a project is already restored, but that is not critical for correct invocation.

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%, so both 'key' and 'reason' are already documented with examples and error handling. The description mentions the reason is filed in the entry, but that is also in the schema's reason description. It adds no additional meaning beyond the schema, 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?

The description uses a specific verb ('Brings back') and resource ('an archived project'), and describes observable effects (files a 'restored' entry, tasks resume). This clearly distinguishes it from siblings like archive_project without requiring the agent to infer the purpose.

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 explicit conditions: only a 'main' token can restore, and non-archived projects are refused with a specific error. It does not name alternatives directly, but the inverse relationship with archive_project is clear from context. The token restriction and error case provide practical guidance for when the tool applies.

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