Vaquill

by io.github.Vaquill-AI

Overview Discussions Admin

Get Document Content

get_document_content

Read-only

Downloads the translated file once the job has completed.

Free. Never charged, and downloading again never charges again.

Authentication: a vq_key_ key holding translate:read.

Bytes, not a link

The file is streamed through this API. The response body IS the file: there is no URL to follow, nothing that expires, and nothing to forward. Send the same Authorization header you use for every other call.

Which file you get

By default, the format you asked for in outputFormat. A job submitted with outputFormat=pdf also produces a Word copy when one could be generated; add ?format=docx to download it. ?format=pdf asks for the PDF explicitly. If the format you ask for does not exist for this job the answer is 404.

Content-Type and Content-Disposition (an attachment with a filename) are set from the file. ETag is supported (If-None-Match gives 304) and so is Range (206) for plain, unencrypted files, so an interrupted download can resume.

Not finished

While status is not completed this is a 404. Poll the status route first.

Example

curl -o translated.pdf \
  https://api.vaquill.ai/api/v1/translation/documents/$DOCUMENT_ID/content \
  -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_content"
  }
}

Input Schema

Name	Required	Description	Default
`id`	Yes
`format`	No

Schema Changelog

Changes observed during successful MCP inspections.

AddedNov 6, 2026

TDQS

A4.6/5.0

Behavior5/5

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

Annotations already cover the safety profile (readOnly, non-destructive), and the description layers on substantial extra context: no charge ever, required `vq_key_` scope `translate:read`, streaming semantics, Content-Type/Content-Disposition/ETag/Range headers with 304 and 206 codes, and 404 conditions.

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?

Well front-loaded and organized under bold headers, with the curl example earning its place. It is on the long side and repeats the no-charge point, but no section is filler.

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?

With no output schema, the description takes responsibility for the return value ('the response body IS the file', headers, resumability) and covers auth, failure modes, and format selection. An agent has everything needed to invoke it correctly.

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 coverage is 0%, so the description must carry the load — and it does for `format`, explaining the default (outputFormat), the ?format=docx and ?format=pdf cases, and the 404 on unavailable formats. The `id` parameter is only implied via the $DOCUMENT_ID placeholder in the curl example, not defined.

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 and resource — 'Downloads the translated file' — and immediately clarifies the delivery model ('the response body IS the file: there is no URL to follow'), which distinguishes it from any link-returning sibling like get_document.

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 preconditions ('once the job has completed', 'Poll the status route first') and explicit when-not behavior (404 while status is not completed, 404 for a nonexistent format). It stops short of naming the sibling tools by name, referring only to 'the status route'.

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

All Vaquill tools Inspect

Try in Browser