Skip to main content
Glama

workflow_archive

Destructive

Fetch all syncable Goodreads resources into a local SQLite database, with incremental sync and full resync to support offline full-text search.

Instructions

Archive fetches all syncable resources from the API and stores them in a local SQLite database. Supports incremental sync (only new data since last run) and full resync. After archiving, use 'search' for instant full-text search.

Input Schema

NameRequiredDescriptionDefault
dbNoDatabase path (default: ~/.local/share/goodreads-cli/data.db)
csvNoOutput as CSV (table and array responses) (default: false)
yesNoSkip confirmation prompts (for agents and scripts) (default: false)
fullNoFull re-archive (ignore previous sync state) (default: false)
jsonNoOutput as JSON (default: false)
agentNoSet all agent-friendly defaults (--json --compact --no-input --no-color --yes) (default: false)
plainNoOutput as plain tab-separated text (default: false)
quietNoBare output, one value per line (default: false)
configNoConfig file path
selectNoComma-separated fields to include in output (e.g. --select id,name,status)
compactNoReturn only key fields (id, name, status, timestamps) for minimal token usage (default: false)
deliverNoRoute output to a sink: stdout (default), file:<path>, webhook:<url>
dry-runNoShow request without sending (default: false)
profileNoApply values from a saved profile (see 'goodreads profile list')
timeoutNoRequest timeout (default: 30s)
no-cacheNoBypass response cache (default: false)
no-colorNoDisable colored output (default: false)
no-inputNoDisable all interactive prompts (for CI/agents) (default: false)
idempotentNoTreat already-existing create results as a successful no-op (default: false)
rate-limitNoMax requests per second (0 to disable) (default: 0)
data-sourceNoData source for read commands: auto (live with local fallback), live (API only), local (synced data only) (default: auto)
human-friendlyNoEnable colored output and rich formatting (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations declare destructiveHint=true and openWorldHint=true, so the agent knows this is a mutating, network-bound operation; the description adds useful detail that it writes to a local SQLite database and supports incremental sync. But it never explains what the destructive flag means in practice—whether existing archived data is overwritten or merged, whether confirmation is required (the 'yes' param implies it), or that the run may be long due to remote fetching.

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?

Three tight sentences, front-loaded with the core action before the incremental/full variants. The trailing pointer to 'search' is efficient but references a command not present among siblings, slightly diluting the value of that sentence.

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?

Given 22 flags, no output schema, and destructive/open-world annotations, the description covers the essential 'what it does and how it differs across modes' story. It leaves out return-value shape and confirmation behavior, but for an archival command whose flags are fully in the schema, this is reasonably complete.

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 description coverage is 100%, so all 22 parameters are already documented, establishing the baseline of 3. The description reinforces the semantics of the 'full' flag (full resync vs incremental) but does not mention any parameter by name or clarify the interaction of 'agent', 'yes', 'dry-run', or 'data-source' with this command.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a concrete verb and resource: fetch all syncable resources from the API and persist them into a local SQLite database. The incremental-vs-full distinction is spelled out. It does not, however, distinguish itself from close siblings like 'sync' and 'import', leaving the agent to infer which one performs the local archive.

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 description implies a workflow (archive first, then use 'search' for full-text search), which is useful routing, but 'search' is not one of the actual sibling tools (the closest are 'sql' and 'goodreads-search_books'). No guidance is given on when to choose this over 'sync' or 'import', or on prerequisites such as authentication.

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