Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_course_get_lesson_quiz

Read-onlyIdempotent

Retrieves the quiz assigned to a lesson in a GoHighLevel course using product, lesson, and location IDs; requires courses.readonly access.

Instructions

COURSES API — the {productId} path parameter is the course (product) id. Get Lesson Quiz Get the quiz for a lesson. Requires a Location token with courses.readonly. Send Version: v3. Endpoint: GET /courses/products/{productId}/lessons/{lessonId}/quiz (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.readonly

Input Schema

NameRequiredDescriptionDefault
lessonIdYesLesson id
productIdYesProduct id
locationIdYesLocation id or sub-account id is required.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already cover safety (readOnly/idempotent/openWorld/non-destructive), yet the description still adds real value: explicit OAuth scope requirements, sub-account token requirement, the mandatory Version: v3 header, and the raw endpoint path. That is meaningful operational context an agent would otherwise have to guess at.

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?

Well front-loaded: API banner, purpose, then endpoint/version, then auth. Slight redundancy in restating the courses.readonly requirement in two separate lines and repeating the v3 header, but the whole block is short and scannable.

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?

For a single read-only GET, it covers auth, versioning, and path semantics thoroughly. The only gap is that no output schema exists and the description says nothing about what the returned quiz object contains (questions, settings, pass threshold), leaving the agent to infer the response shape.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description earns extra credit by clarifying that productId means the course/product id and that lessonId sits in the path alongside it. It does not add format details (UUID) beyond the schema, so it is above but not at the top of the scale.

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 precise verb + resource ('Get the quiz for a lesson') and adds the crucial disambiguation that {productId} is the course/product id, which the sibling course tools (get_lesson, get_quiz_questions, update_quiz) do not overlap. An agent can identify the exact object fetched without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by 'Get the quiz for a lesson' and the read-only nature, but no sibling is named and there is no when-not guidance (e.g. use get_quiz_questions for question content, get_lesson_assignment for assignments). Prerequisites (location token, courses.readonly scope) are stated but those are auth facts rather than routing guidance.

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

Deploy Server

Other Tools