Skip to main content
Glama

Get snapshots

archivebox_get_snapshots
Read-onlyIdempotent

Retrieve and filter archived snapshots by ID, URL, tag, title, creator, or date, with search and pagination support.

Instructions

Retrieve list of snapshots

Args: id: Filter by snapshot ID. abid: Filter by snapshot abid. created_by_id: Filter by creator ID. created_by_username: Filter by creator username. created_at__gte: Filter by creation date >= (ISO 8601 format). created_at__lt: Filter by creation date < (ISO 8601 format). created_at: Filter by exact creation date (ISO 8601 format). modified_at: Filter by exact modification date (ISO 8601 format). modified_at__gte: Filter by modification date >= (ISO 8601 format). modified_at__lt: Filter by modification date < (ISO 8601 format). search: Search across url, title, tags, id, abid, timestamp. url: Filter by URL (exact). tag: Filter by tag name (exact). title: Filter by title (icontains). timestamp: Filter by timestamp (startswith). bookmarked_at__gte: Filter by bookmark date >= (ISO 8601 format). bookmarked_at__lt: Filter by bookmark date < (ISO 8601 format). with_archiveresults: Include archiveresults in response. limit: Number of results to return. offset: Offset for pagination. page: Page number for pagination. api_key: API key for QueryParamTokenAuth (optional).

Returns: Response: The response object from the GET request.

Raises: ParameterError: If the provided parameters are invalid.

Input Schema

NameRequiredDescriptionDefault
idNo
tagNo
urlNo
abidNo
pageNo
limitNo
titleNo
offsetNo
searchNo
api_keyNo
timestampNo
created_atNo
modified_atNo
created_by_idNo
created_at__ltNo
created_at__gteNo
modified_at__ltNo
modified_at__gteNo
bookmarked_at__ltNo
bookmarked_at__gteNo
created_by_usernameNo
with_archiveresultsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.5.1

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so the safety profile is covered. The description adds optional api_key authentication and a ParameterError on invalid parameters, but does not describe rate limits or meaningful return behavior beyond a generic 'Response object'.

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?

The purpose is front-loaded and the Args list is compact and structured. For 22 optional parameters the length is largely justified, though the Returns/Raises boilerplate adds minor noise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 22 optional parameters and no output schema, the description does well on parameter meaning but only says the return is a 'Response object' and does not explain response shape or pagination defaults. Annotations cover safety, but result semantics remain underspecified.

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?

Schema description coverage is 0%, so the description must compensate; it documents all 22 parameters with useful filter semantics such as exact match, icontains, startswith, ISO 8601 date operators, and pagination fields. It still leaves the page/offset/limit relationship and the id vs abid distinction somewhat ambiguous, so it is not perfect.

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 specific verb ('Retrieve') and resource ('list of snapshots'), so the basic purpose is clear. It does not distinguish this tool from the singular sibling archivebox_get_snapshot or other get_* tools, so it falls short of full sibling differentiation.

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 filter arguments imply that this tool is for querying/filtering snapshots, but there is no explicit when-to-use guidance, no exclusions, and no named alternative such as archivebox_get_snapshot. The agent must infer the distinction from the tool name and siblings.

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