Skip to main content
Glama
zackscriven

ghl-mcp-server-v2

by zackscriven

ghl_course_review_assessment

Idempotent

Submit a review for a course assessment by setting its status, score, and learner feedback through the GoHighLevel Courses API.

Instructions

COURSES API — the {productId} path parameter is the course (product) id. Review Assessment Review an assessment submission. Requires a Location token with courses.write. Send Version: v3. Location tokens are not a staff reviewer. Endpoint: PUT /courses/products/{productId}/assessments/{assessmentId}/review (Version header: v3; source: v3/courses-v3.json) Requires a Sub-Account (location) token. OAuth scopes: courses.write

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
productIdYesProduct id
locationIdYesLocation id or sub-account id is required.
assessmentIdYesAssessment id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, so the mutation/idempotency profile is covered. The description adds genuinely new context beyond that: the Version: v3 header requirement, the exact HTTP endpoint, the courses.write OAuth scope, and a caveat that 'Location tokens are not a staff reviewer'. It does not explain the effect of the review on the submission or learner (e.g. whether a notification fires), which keeps it from a 5.

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

Conciseness3/5

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

The purpose and endpoint are front-loaded, but the token/scope requirement is stated three times in different phrasings ('Location token with courses.write', 'Requires a Sub-Account (location) token', 'OAuth scopes: courses.write'), and the leading note about the productId parameter is repeated implicitly by the endpoint path. Trimming the redundant auth lines would make it tighter.

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 4-parameter nested-body write tool with no output schema, the description covers the essentials an agent needs to invoke it: endpoint, version header, auth scope, sub-account requirement, and path-parameter meaning, with the body fully specified in the schema. It stops short of describing the response or the state transition produced by a review, which is the main remaining gap.

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 baseline is 3; every field including the nested body (status enum, score, feedback) is already documented in the schema. The description adds only a small clarification that the {productId} path parameter is the course (product) id, which is marginal over the schema's 'Product id'.

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?

The description states a specific verb and resource — 'Review an assessment submission' — and pins it to the PUT /courses/products/{productId}/assessments/{assessmentId}/review endpoint. Combined with the courses.write scope, an agent can tell this apart from the read-only siblings ghl_course_get_assessment and ghl_course_list_assessments 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?

The description establishes the auth prerequisite ('Requires a Location token with courses.write', 'Requires a Sub-Account (location) token'), which tells the agent when the call will succeed. However, it never states when to choose this tool over alternatives, nor any exclusion such as 'not for creating assessments' or 'use list_assessments to find the assessmentId first'. Usage is only implied by the verb 'Review'.

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