Skip to main content
Glama

site_snapshot

Idempotent

Creates a comprehensive backup of Voog site data before risky operations like layout changes or page deletion. Use as a safety net to enable restoration if needed.

Instructions

Comprehensive read-only backup of every mutable Voog resource: pages, articles, elements, layouts, layout_assets, languages, redirect_rules, nodes, texts, content_partials, tags, forms, media_sets, assets, webhooks, site, me, products (with translations + variant_types), per-page contents, per-article details, per-product details, and rendered HTML samples for VoogStyle capture. By default REFUSES to overwrite an existing directory — pick a fresh location. Pass overwrite=true to write into an existing directory (automation/cron use case); files from a prior snapshot may persist alongside new files if the underlying Voog state has shrunk. REQUIRED pre-flight before any risky operation: layout rename, mass push, layout swap, VoogStyle template push, page_delete. Writes _meta.json manifest to output_dir documenting voog-mcp version, attempted/succeeded/skipped/failed endpoints, request_count, duration_seconds, and (if the snapshot aborted mid-run) aborted_reason. Restore tooling reads this to refuse partial snapshots.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteYesSite name from voog_list_sites
output_dirYesAbsolute path. Fresh (non-existing) by default; pass overwrite=true to allow existing.
overwriteNoAllow writing into an existing snapshot directory. Default false; set true to overwrite a prior snapshot's output. (Distinct from the force flag on delete tools, which authorizes destruction. Here it only authorizes writing into an existing dir.)
Behavior1/5

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

The description claims a read-only backup, but the annotation readOnlyHint is false, creating a direct contradiction. While the description adds many behavioral details (overwrite behavior, partial snapshot handling, _meta.json), the contradiction undermines trust. The description does not clarify why readOnlyHint is 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 comprehensive yet concise, with a logical structure: it opens with the tool's scope, then covers default behavior, overwrite flag, required pre-flight contexts, and the manifest output. Every sentence serves a purpose, and the information is front-loaded.

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 the complexity (many resources, overwrite behavior, error handling, manifest), the description covers most aspects. However, it does not explicitly describe the tool's return value (though it implies success through file writing). The lack of output schema is not critical, but an agent might want to know what the tool returns besides writing files.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

All three parameters have descriptions in the input schema (100% coverage). The description adds valuable context: it explains the default behavior of output_dir (fresh vs existing), the semantic of overwrite (authorizing writing into existing dir, distinct from force), and the relationship to automation/cron. This goes beyond the schema.

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 it is a comprehensive read-only backup of all mutable Voog resources, listing many specific resource types. It distinguishes from sibling tools like layouts_pull or pages_snapshot by being a full site backup, and it identifies when to use it (pre-flight for risky operations).

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

Usage Guidelines5/5

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

The description provides explicit guidance: it is required pre-flight before risky operations like layout rename, mass push, or page_delete. It also explains the default refusal to overwrite and the overwrite flag for automation. This clearly establishes when and how to use the tool.

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/runnel/voog-mcp'

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