Skip to main content
Glama

Export a SCORM package

export_scorm
Read-onlyIdempotent

Builds a SCORM package for a course and returns the .zip base64-encoded. For bulk migration prefer GET /api/v1/courses/:id/scorm, which streams the zip instead. Requires the Build plan or higher.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
trackNoAlso report runs back to Underlayer analytics, keyed to the LMS's own learner id.
localeNoPackage a translated locale instead of the source language.
versionNoDefaults to scorm2004.
courseIdYesId of the course to package.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
bytesYesSize of the .zip in bytes.
versionYes
fileNameYesThe package's file name. The .zip itself arrives as an embedded resource.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds genuinely useful context beyond that: the base64 encoding of the payload, the streaming alternative for bulk work, and the Build-plan-or-higher entitlement requirement. No contradiction with readOnlyHint, since packaging is a read/export operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, each carrying distinct information (output form, alternative route, plan gate), with the core purpose front-loaded. No 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?

An output schema exists, so return-value details need not be repeated. The description covers the operation, its output encoding, the plan prerequisite, and the escalation path for bulk use, which is everything an agent needs to select and invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all four parameters (track, locale, version, courseId) including the enum and default. The description adds no parameter-level detail, so the baseline 3 applies.

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 ('Builds a SCORM package for a course') and specifies the return form (.zip, base64-encoded). This clearly separates it from the sibling import_scorm and from generic course tools.

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 an explicit condition and alternative: bulk migration should use the streaming REST endpoint instead. It does not name any sibling tool as an alternative, but the routing guidance is concrete and actionable.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources