Skip to main content
Glama

Review course

get_course_review

Returns the pre-publish checkpoint: readiness, outline, the Trainn editor link, and a learner preview link when the course is published. Present review_url as “Review and edit in Trainn” and preview_url as “Preview as learner”. Do not restate the course. Publishing remains a separate publish_course call after explicit confirmation.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "course_id": "<course_id>"
    },
    "name": "get_course_review"
  }
}

Input Schema

NameRequiredDescriptionDefault
course_idYes

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.7/5.0
Behavior4/5

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

Beyond the annotations, the description discloses what the payload contains, that preview_url is conditional (only present when the course is published), and that no publishing occurs here. That conditional-return note is genuinely useful behavioural context an agent could not get from the schema. There is mild tension with readOnlyHint=false for a tool framed purely as a returning read, but the description never claims side-effect-freeness in general, so it is not a direct contradiction.

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

Conciseness4/5

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

Four short sentences, front-loaded with what is returned, followed by presentation directives and one guardrail. The label instructions ("Review and edit in Trainn", "Preview as learner") are unusual but earn their place because they change agent output. Slightly mixed purpose between capability description and UI scripting, but no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With one required parameter and no output schema, the description carries the return-shape burden and mostly does so by enumerating readiness, outline, review_url and preview_url. Remaining gaps, such as what "readiness" comprises or what happens for an unpublished or unknown course beyond the preview link being absent, are minor.

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

Parameters2/5

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

The only parameter is course_id and the schema description coverage is 0%, so the description is the only place meaning could be added — and it never mentions course_id at all. It is arguably self-explanatory by name, but the definition does nothing to compensate for the coverage gap, e.g. no note on whether the id is the course id, draft id, or an external reference.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a concrete verb and a concrete resource: it returns the pre-publish checkpoint with readiness, outline, editor link and preview link. That is specific enough for an agent to pick it over the many write-oriented siblings, and it explicitly separates the read from publish_course. It does not, however, distinguish itself from near-neighbours like get_course_draft or get_course_build_status, so the differentiation is partial.

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?

"Pre-publish checkpoint" places the tool at a clear point in the workflow, and "Publishing remains a separate publish_course call after explicit confirmation" is an explicit routing statement naming the alternative. It also gives output-handling guidance (use the label "Review and edit in Trainn", do not restate the course). It stops short of saying when to prefer this over get_course_draft or get_course_build_status.

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