Built LMS Help Center
MCP ServerTool Reference

Set Path Status

Set Path Status MCP tool.

Set Path Status

Publish a learning path or return it to draft. Publish fails with no nodes or a missing course or exam; unpublish fails while it has enrollments.

Contract

FieldValue
Tool nameset_path_status
Domainlearning_paths
Required scopescourses:manage
TitleSet learning path status
Read only hintfalse
Destructive hinttrue
Idempotent hinttrue
Open world hintfalse
Bulk limitnone
Timeout10000ms
Kill switch keylearning_paths.status
REST siblingPOST /api/public/v1/learning-paths/{id}/{action}

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "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)$"
    },
    "action": {
      "type": "string",
      "enum": [
        "publish",
        "unpublish"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 200,
      "pattern": "^[A-Za-z0-9._:-]+$"
    }
  },
  "required": [
    "id",
    "action",
    "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