MCP Tools Reference
The Ollang MCP server exposes the following tools, grouped by category. Each tool maps to one or more endpoints in the Ollang Integration API — MCP simply gives your AI assistant a natural-language interface to them.File Management
uploadFile
uploadFile
Upload files for processing and translation. Supports videos (MP4, AVI, MOV), documents (PDF, DOCX), images in JPEG, JPG, or PNG for Image to Image translation, audio files, subtitles, JSON, and DITA/XML content.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | File name (e.g., video.mp4, document.pdf) |
sourceLanguage | string | Yes | Source language code (e.g., en, es, fr) |
url | string | No | URL to download the file from (presigned URLs supported) — fetched server-side, so any file size the API accepts works |
base64Content | string | No | Base64-encoded binary file content (e.g., a local PDF or DOCX) — best for smaller files |
expectedSize | number | No | Expected decoded size in bytes of base64Content; the upload fails on mismatch |
sha256 | string | No | Expected SHA-256 hex digest of the decoded base64Content; the upload fails on mismatch |
content | string | No | JSON content as a string (not for binary files — use base64Content) |
ditaContent | string | No | DITA/XML content as a string |
notes | array | No | Array of order notes with details and optional timeStamp |
folderId | string | No | Folder ID to place the project in (must belong to the same client) |
Provide exactly one of
url, base64Content, content, or ditaContent — one source per upload. Base64 payloads travel through the AI assistant’s context, so prefer url for files larger than a few megabytes, and pass expectedSize and/or sha256 with base64Content so uploads fail loudly if the data is corrupted in transit.uploadVttFile
uploadVttFile
Upload a VTT subtitle file for a project, from WebVTT content or a URL.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project ID to upload the VTT file for |
name | string | Yes | Name of the VTT file (e.g., subtitles.vtt) |
vttContent | string | No | WebVTT content as a string (must start with the WEBVTT header) |
url | string | No | URL to download the VTT file from |
sourceLanguage | string | No | Source language code of the subtitles |
Provide exactly one of
vttContent or url.Order Management
createOrder
createOrder
Create a new translation or transcription order.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | Project ID from a previous file upload |
orderType | string | Yes | One of: cc, subtitle, aiDubbing, studioDubbing, document |
level | number | Yes | 0 = full AI, 1 = AI + human review |
targetLanguageConfigs | array | Yes | Array of { language: string, isRush?: boolean } |
getOllangOrders
getOllangOrders
Fetch orders with pagination, search, and sorting.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
page | number | No | Page number (default: 1) |
take | number | No | Items per page (1–50, default: 10) |
search | string | No | Search query |
orderBy | string | No | Sort field (default: id) |
orderDirection | string | No | asc or desc (default: desc) |
getOrderById
getOrderById
Get detailed information about a specific order including QC results.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order ID |
cancelOrder
cancelOrder
Cancel an existing order.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order ID to cancel |
rerunOrder
rerunOrder
Re-run an order to regenerate the translation with current AI models.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order ID to rerun |
Quality Control
runQcEvaluation
runQcEvaluation
Run an AI-powered quality control evaluation on an order.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order ID to evaluate |
accuracy | boolean | No | Evaluate translation accuracy (default: true) |
fluency | boolean | No | Evaluate fluency in target language (default: true) |
tone | boolean | No | Evaluate tone and style (default: true) |
culturalFit | boolean | No | Evaluate cultural appropriateness (default: true) |
customPrompt | string | No | Custom evaluation instructions |
requestHumanReview
requestHumanReview
Escalate an order for manual review by a human translator.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order ID |
Revisions
createRevision
createRevision
Report issues or request changes to delivered content.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order ID |
type | string | Yes | Issue type: missingSubtitle, wrongSubtitle, syncError, formatError, other |
description | string | No | Detailed description of what needs correction |
time | string | No | Timestamp where the issue occurs (format: HH:MM:SS) |
getOrderRevisions
getOrderRevisions
Retrieve all revision requests for an order.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order ID |
deleteRevision
deleteRevision
Delete a specific revision request.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | The order ID |
revisionId | string | Yes | The revision ID to delete |
Projects
getAllProjects
getAllProjects
Retrieve all projects with pagination, search, and sorting.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
page | number | No | Page number (default: 1) |
take | number | No | Items per page (1–50, default: 10) |
search | string | No | Search query |
orderBy | string | No | Sort field (default: id) |
orderDirection | string | No | asc or desc (default: desc) |
getProjectById
getProjectById
Get detailed information about a specific project.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project ID |
Custom Instructions
getAllCustomInstructions
getAllCustomInstructions
Retrieve all custom translation instructions for your account.Parameters: None
createCustomInstruction
createCustomInstruction
Create a new reusable translation guideline.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Title of the instruction |
content | string | Yes | The guideline content |
updateCustomInstruction
updateCustomInstruction
Update an existing custom instruction.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
instructionId | string | Yes | The instruction ID |
title | string | No | New title |
content | string | No | New content |
deleteCustomInstruction
deleteCustomInstruction
Delete a custom instruction permanently.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
instructionId | string | Yes | The instruction ID |
Utilities
healthCheck
healthCheck
Check the health status of the Ollang API.Parameters: None
downloadAndReadSubtitle
downloadAndReadSubtitle
Download and parse subtitle files from URLs. Supports SRT, VTT, ASS, and SSA formats.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
url | string | Yes | URL of the subtitle file |
format | string | No | Format hint: auto, srt, vtt, ass, ssa (default: auto) |
downloadAndReadJSON
downloadAndReadJSON
Download and parse JSON files from URLs.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
url | string | Yes | URL of the JSON file |
downloadAndReadDITA
downloadAndReadDITA
Download and parse DITA/XML documentation files from URLs.Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
url | string | Yes | URL of the DITA file (.dita, .ditamap, or .ditaval) |