Skip to main content
Glama

klax_write_study_note_html

Save structured study notes as a local HTML file after verifying page or slide locators against source materials. Rejects saving if locators are missing, ensuring accurate, reference-backed learning notes.

Instructions

모델이 교안 원문을 읽고 작성한 구조화된 note JSON을, 출처 locator 검증 후 로컬 단일 HTML 학습 노트로 저장합니다.

note 필수 필드: title, overview, sections[]. 각 섹션에는 title, explanation, why_it_matters, source_locators(page:N/slide:N 등)가 필요합니다. 이 도구는 LLM/API를 호출하지 않고 HTML만 렌더링하며, locator가 색인 자료에 없으면 저장을 거부합니다.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteYes
course_idYes
output_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

With no annotations, the description carries the full burden. It discloses that the tool does not call LLM/API, only renders HTML, rejects saving if locators are not in the index, and writes a local file. This is thorough behavioral disclosure for a mutation tool.

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?

Three sentences in Korean, front-loaded with the main purpose, then behavioral details. Each sentence adds value with no redundant wording.

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?

Given the nested note parameter and the output schema presence, the description covers the note structure, validation behavior, and local write. It could mention error cases beyond locator rejection, but that is minor.

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 0%, so the description must compensate. It details the required structure of the note object (title, overview, sections with title, explanation, why_it_matters, source_locators) and gives locator examples. It does not explain course_id or output_path, but their names are self-explanatory.

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 (save), a concrete resource (local single HTML study note), and a distinguishing process (validating source locators before saving). This clearly separates it from siblings like klax_generate_study_guide_html, which generates a guide rather than persisting a pre-built note.

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?

The description provides clear context: it is for saving a structured note after the model writes it, and it explicitly notes that it does not call LLM/API, implying it is a local renderer. However, it does not explicitly name alternatives or state when not to use it.

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