Skip to content
ChalkSurf Docs

Generate exercise translation job

generate_exercise_translation_job

Section titled “generate_exercise_translation_job”

Use this to queue translation generation for one writable ChalkSurf exercise.

Contract metadata

Section titled “Contract metadata”
{
  "annotations": {
    "readOnlyHint": false,
    "destructiveHint": false,
    "idempotentHint": false,
    "openWorldHint": false
  },
  "fileParams": [],
  "requiredPermission": "write",
  "security": {
    "type": "oauth2",
    "scopes": [
      "chalksurf:write"
    ]
  }
}

Input schema

Section titled “Input schema”

The server advertises this JSON Schema to MCP clients. Runtime authorization and business-rule checks still apply.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "id": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "organizationId": {
      "description": "The ChalkSurf organization ID to use for this request.",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "targetLanguages": {
      "items": {
        "enum": [
          "english",
          "hungarian",
          "german",
          "french",
          "spanish",
          "italian"
        ],
        "type": "string"
      },
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "id",
    "targetLanguages",
    "organizationId"
  ],
  "type": "object"
}

Output schema

Section titled “Output schema”
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "jobs": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "exerciseId": {
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
            "type": "string"
          },
          "jobId": {
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
            "type": "string"
          },
          "languages": {
            "items": {
              "enum": [
                "english",
                "hungarian",
                "german",
                "french",
                "spanish",
                "italian"
              ],
              "type": "string"
            },
            "minItems": 1,
            "type": "array"
          },
          "type": {
            "const": "exercise_translation_generation",
            "type": "string"
          }
        },
        "required": [
          "exerciseId",
          "jobId",
          "languages",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "jobs"
  ],
  "type": "object"
}