Deterministic test fixtures: save the project's entire dataset under a name, restore it exactly later (list/delete too). Any GET can also be served read-only FROM a snapshot without touching live data via query param mock_snapshot= in query_records params — parallel test scenarios on one project.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Snapshot name (required for restore/delete; default for save: snapshot-<n>). | |
| action | Yes | ||
| project | Yes | ||
| adminKey | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description clearly discloses the tool's behavior: saving entire dataset, exact restoration, list/delete operations, and read-only serving from snapshots. It does not cover potential side effects like overwriting existing snapshots or permission requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, with two sentences covering core functionality and an advanced use case. No redundant information, and key details are front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers primary use cases and the advanced mock_snapshot feature, but lacks details on return values (e.g., what list returns) and error scenarios. Given no output schema, this is a notable gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds meaning to the action enum (save, list, restore, delete) and notes the default naming for save. However, project and adminKey parameters remain unexplained, and schema coverage is only 25%, leaving gaps.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool's purpose: creating deterministic test fixtures by saving, restoring, listing, and deleting snapshots of the entire project dataset. It clearly distinguishes from siblings by focusing on testing scenarios.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides practical guidance, including an advanced use case for serving GET requests from a snapshot via query param, enabling parallel test scenarios. However, it does not explicitly name alternative tools or state when not to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool maps to a distinct resource/operation: project lifecycle, resource seeding, artifact import, record CRUD, custom routes, snapshots, request inspection, and external API status. Even the data-population tools are clearly separated by existing project (add_resource) versus new project (import_data/create_project).
Most tools follow a clear verb_noun pattern (add_resource, create_project, query_records, write_record, delete_project, etc.). A few noun-style names (custom_route, project_info, snapshots) break the pattern, but all names are snake_case and readable.
Eleven tools is a well-scoped set for a mock API server: project creation/deletion, data population/import, record operations, snapshots, custom routes, inspection, and API status all have dedicated tools without redundancy.
The core workflow is well covered: create/delete projects, add/import resources, CRUD records, snapshot state, define routes, and inspect requests. The main gaps are the lack of explicit resource deletion and custom-route update/delete, but these are workaroundable rather than blocking.