Built LMS Help Center
MCP ServerTool Reference

Start Course Generation

Start Course Generation MCP tool.

Start Course Generation

Start an AI course generation run; returns run_id at once and runs in the background. Topic-only runs need delivery_format microlearning; standard needs a reviewed curriculum. source_material_ids are materials already uploaded to the organization. profile_version_id defaults to the organization profile. Every run pauses at manuscript review until a person approves it in the admin dashboard; no tool can. Poll get_course_generation. status preflight_pending: the same idempotency_key is still starting; repeat the call.

Contract

FieldValue
Tool namestart_course_generation
Domaincourses
Required scopesai:manage
TitleStart course generation
Read only hintfalse
Destructive hintfalse
Idempotent hinttrue
Open world hintfalse
Bulk limitnone
Timeout60000ms
Kill switch keycourse_generations.start
REST siblingPOST /api/public/v1/course-generations

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "topic": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "description": {
      "type": "string",
      "maxLength": 5000
    },
    "requirements": {
      "type": "string",
      "maxLength": 10000
    },
    "delivery_format": {
      "type": "string",
      "enum": [
        "standard",
        "microlearning"
      ]
    },
    "complexity": {
      "type": "string",
      "enum": [
        "beginner",
        "intermediate",
        "advanced"
      ]
    },
    "curriculum": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "minLength": 1,
          "maxLength": 300
        },
        "description": {
          "type": "string",
          "maxLength": 5000
        },
        "target_audience": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 1000
            },
            {
              "type": "null"
            }
          ]
        },
        "difficulty": {
          "type": "string",
          "enum": [
            "beginner",
            "intermediate",
            "advanced"
          ]
        },
        "learning_objectives": {
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 1000
          }
        },
        "lessons": {
          "minItems": 1,
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "minLength": 1,
                "maxLength": 300
              },
              "description": {
                "type": "string",
                "maxLength": 5000
              },
              "key_topics": {
                "maxItems": 50,
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 500
                }
              },
              "learning_objectives": {
                "maxItems": 50,
                "type": "array",
                "items": {
                  "type": "string",
                  "maxLength": 1000
                }
              },
              "suggested_bloom": {
                "type": "string",
                "enum": [
                  "Remember",
                  "Understand",
                  "Apply",
                  "Analyze",
                  "Evaluate",
                  "Create"
                ]
              }
            },
            "required": [
              "title",
              "description",
              "key_topics",
              "learning_objectives",
              "suggested_bloom"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "title",
        "description",
        "difficulty",
        "learning_objectives",
        "lessons"
      ],
      "additionalProperties": false
    },
    "source_material_ids": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "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)$"
      }
    },
    "theme_id": {
      "type": "string",
      "enum": [
        "folio",
        "broadsheet",
        "vellum",
        "studio-craft",
        "arcade",
        "storyboard",
        "poster",
        "dispatch",
        "voltage",
        "caliber",
        "console",
        "apex",
        "sirocco"
      ]
    },
    "assessment_policy": {
      "type": "string",
      "enum": [
        "mixed",
        "course-final-only",
        "lesson-end",
        "ai-decide"
      ]
    },
    "course_passing_score": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100
    },
    "include_assignments": {
      "type": "boolean"
    },
    "time_limit_minutes": {
      "type": "integer",
      "minimum": 5,
      "maximum": 240
    },
    "profile_version_id": {
      "type": "string",
      "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)$"
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "pattern": "^[A-Za-z0-9._:-]+$"
    }
  },
  "required": [
    "topic",
    "delivery_format",
    "idempotency_key"
  ],
  "additionalProperties": false
}

Output Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "const": "text"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "text"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "content"
  ],
  "additionalProperties": false
}

On this page