Skip to main content
Glama
benpalmer1

Gorgias MCP Server

by benpalmer1

Unarchive Macros (Bulk)

gorgias_unarchive_macros
Idempotent

Restore archived macros to active status in bulk by providing their IDs. Accepts up to 30 IDs per request and returns per-ID results.

Instructions

PUT /api/macros/unarchive — Bulk unarchive multiple previously archived macros by ID. Restores macros to active status. Max 30 IDs per request. Returns per-ID results.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsYesList of macro IDs to unarchive (min: 1, max: 30 per request)
Behavior4/5

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

The description adds useful operational details beyond the annotations: it states the restoration effect, the bulk limit of 30 IDs, and the per-ID results format. With no output schema, this return format is particularly valuable. It is consistent with the idempotentHint and readOnlyHint=false.

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?

The description is compact and front-loaded, starting with the endpoint and primary action, followed by three short sentences each containing a distinct fact: restoration effect, 30-ID limit, and per-ID results. No wasted words.

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 simple one-parameter bulk mutation, the description captures all essential details: endpoint, action, effect, constraint, and response format. It does not need to explain return values further because the per-ID results statement covers it. This is complete for its complexity.

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?

The schema fully documents the 'ids' parameter with type, min/max items, and a description, providing 100% coverage. The tool description adds no extra parameter semantics beyond the redundant 'by ID' phrasing, so the baseline score of 3 is appropriate.

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 clearly states the action ('Bulk unarchive multiple previously archived macros'), the resource (macros), and the effect ('Restores macros to active status'). It distinguishes from siblings by specifying 'previously archived' and the bulk nature, making it distinct from archive/delete operations.

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 by targeting 'previously archived macros' and specifying the bulk operation (max 30 IDs per request). It doesn't explicitly name alternatives or exclusions, but the context is clear enough for an agent to select it over archive or delete macros tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/benpalmer1/Gorgias-MCP-Server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server