SHIP

Get site database export

get_site_database_export

Read-onlyIdempotent

Read the status of a site database export: running, ready, failed or expired. While it runs, the call waits up to about 15 seconds for the file. An export that nobody reads for a minute stops, so call this again after pollAfterSeconds. The file is not part of the result. When the status is ready, download it with ship sites export-db <SITE_ID> --export <EXPORT_ID>, or from GET /v1/sites/{siteId}/database/exports/{exportId}/file.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "siteId": "<siteId>",
      "exportId": "<exportId>"
    },
    "name": "get_site_database_export"
  }
}

Input Schema

Name	Required	Description	Default
`siteId`	Yes	Site id from list_sites
`exportId`	Yes	Export id from start_site_database_export

Output Schema

Name	Required	Description
`id`	Yes
`siteId`	Yes
`status`	Yes	`running` until the file is made. `ready` while the file can be downloaded. `expired` after `expiresAt`: start a new export. `failed` gives the cause in `failure`.
`failure`	Yes
`filename`	Yes
`createdAt`	Yes
`expiresAt`	Yes
`completedAt`	Yes
`pollAfterSeconds`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

AddedNov 8, 2026

TDQS

A4.5/5.0

Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), yet the description adds genuinely non-obvious behavior: a ~15-second blocking wait, and the critical operational detail that an export nobody reads for a minute stops. It also warns that the file itself is not returned. That is exactly the kind of context annotations cannot express.

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?

Five tight sentences, front-loaded with purpose, then blocking behavior, then the expiry caveat, then the retrieval path. Every sentence carries actionable information and nothing is repeated from the schema or annotations.

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 polling-style read tool with an output schema and full annotation coverage, the description covers everything an agent needs to call it correctly: status semantics, latency, the liveness/expiry trap, and how to actually obtain the file. Nothing material is left unspecified.

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 both parameters are already documented with their provenance (siteId from list_sites, exportId from start_site_database_export). The description reinforces the identifiers via the CLI example and introduces pollAfterSeconds, but that appears to be a return field rather than an input, so it adds little parameter meaning beyond the schema. Baseline 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?

States a specific verb (read status) and resource (site database export) and enumerates the exact status domain: running, ready, failed, expired. An agent can immediately distinguish this from start_site_database_export (which creates one) and list_site_database_exports (which lists many), even without opening either schema.

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?

Gives clear operational guidance: it explains that the call may block for ~15s, and that you should call it again after pollAfterSeconds, which in practice defines the polling workflow. It also routes the agent to the follow-up action once ready (CLI command or GET endpoint). The only gap is that it never explicitly contrasts itself with the sibling list_site_database_exports.

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

All SHIP tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.