Skip to main content

Module hints

Module hints 

Source
Expand description

Just-in-time hints placed inside structured results. Hints state facts; they never tell the agent to run a command (the skill holds the procedures).

Structs§

Hint
A fact for the agent, placed in the structured result.

Enums§

HintKind
What a Hint tells the agent.
SkillRefusal
Why a call is refused over the skill it reports.

Constants§

CURRENT_SKILL_VERSION
The skill version this server is built for.
MINIMUM_SKILL_VERSION
The oldest skill version this server still works with.
SKILL_DECLINED
The skill_version an agent sends once the teacher has said no to installing the skill.
SKILL_SETUP_URL
Where teachers learn to set up the skill.

Functions§

answered_task_instructions_edited
Task instructions edited on an exercise students have already answered.
blocks_moved_between_pages
Moved blocks keep their ids, so feedback and proposed edits follow them.
check_skill_version 🔒
exercises_copied
Copied exercises are new ones without submissions.
format_tips
Format facts for the block types in a result, from the CMS schema export. block_names are distinct.
links_to_old_paths
Links to moved pages keep working through redirects.
links_to_reused_paths
Links to paths that other pages now have open those pages instead.
needs_teacher_review
Risky changes wait for the teacher on the review page.
published
The changeset is published. is_draft as in staged.
published_rendering_changes
Pages a just published changeset changed the rendering of.
redirects_created
Moved pages get redirects when the changeset is published.
rendering_changes
Pages of the open changeset render differently from the published course.
review_config_switched_with_reviews
Switching an exercise’s review config orphans the reviews students have given.
skill_missing
The refusal of a call that sent no skill_version, written for the agent to relay to the teacher.
skill_version
Checks the skill_version a call sent against CURRENT_SKILL_VERSION and MINIMUM_SKILL_VERSION. No hint means the skill is current or newer. A missing version only gives a hint here; tools that need the skill refuse it with skill_missing.
staged
Changes are staged and wait for publishing. is_draft: the course is a draft, which students don’t see even after publishing.
submissions_affected
Removed exercises have student submissions.
template_placeholders
The page still holds placeholder text from a default page template.