Skip to main content
Glama

Get Document

get_document
Read-only

Returns the status of a document translation job.

Free. Never charged, so poll as often as the rate limit allows. A sensible cadence is every 2 to 5 seconds.

Authentication: a vq_key_ key holding translate:read.

Status

status

Meaning

pending

Queued, not started.

processing

Being translated. progress runs from 0 to 100.

completed

Done. Download it from /content. pagesCharged is set.

failed

Not translated and not charged. See error.code.

pagesCharged is null until the job completes, because pages are charged once, on completion.

Errors

error.code is INSUFFICIENT_TRANSLATION_PAGES (your balance did not cover the document when it was processed) or TRANSLATION_FAILED. Neither charges you.

Example

curl https://api.vaquill.ai/api/v1/translation/documents/$DOCUMENT_ID \
  -H "Authorization: Bearer $VAQUILL_API_KEY"

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": {
      "id": "<id>"
    },
    "name": "get_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds real context beyond that: the call is never charged, rate limits apply, auth requires a vq_key_ with translate:read, and pagesCharged stays null until completion. That is solid added value, though it does not cover pagination or latency behavior.

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 and the free/polling note are front-loaded, and the status table plus error section are scannable and each earn their place. The verbose curl example partially duplicates the authentication and URL information already stated, adding modest redundancy.

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?

An output schema exists, so return-value explanation is optional, yet the description goes further by enumerating status values, progress semantics and error codes. The one substantive gap is that it never explains where the required document id comes from or which sibling tool produces it.

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

Parameters2/5

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

The single parameter 'id' has 0% schema description coverage, leaving the description responsible for explaining it. The only hint is '$DOCUMENT_ID' inside a curl example; it never says the id is the value returned by create_document or upload_file, nor what format it takes, so an agent must infer the parameter's origin.

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?

The opening line states a specific verb and resource: retrieving the status of a document translation job, which is narrower and clearer than the bare name 'get_document'. It distinguishes itself from content retrieval only indirectly by pointing at '/content' as the download path rather than naming the sibling tool get_document_content.

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?

It gives concrete usage context: poll this endpoint, at a 2-5 second cadence, and it is free so polling is unlimited within rate limits. What's missing is an explicit handoff statement such as 'once status is completed, call get_document_content to download' — the routing hint is given as a raw HTTP path instead of a sibling tool name.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.