Skip to main content
Glama

teach

Records a query-to-resource mapping for future recall, enabling silent LLM-fired learning so repeated questions can reuse known AnkiWeb resources.

Instructions

Record a query -> resource mapping for future recall (LLM-fired, silent)

Input Schema

NameRequiredDescriptionDefault
csvNoOutput as CSV (table and array responses) (default: false)
yesNoSkip confirmation prompts (explicit confirmation for scripts) (default: false)
jsonNoOutput as JSON (default: false)
agentNoSet agent-friendly output defaults (--json --compact --no-input --no-color) (default: false)
notesNoOptional free-form note recorded in the audit log
plainNoOutput as plain tab-separated text (default: false)
queryNoUser's original natural-language question (required)
quietNoSilent on success (default true — designed for background invocation) (default: true)
venueNoOptional venue scope tag stored with the learning
selectNoComma-separated fields to include in output (e.g. --select id,notetype_id,deck_id)
compactNoReturn only key fields (id, name, status, timestamps) for minimal token usage (default: false)
dry-runNoShow request without sending (default: false)
max-ageNoMaximum acceptable age of local-store data before a stderr hint suggests sync; 0 disables (default: 30m0s)
receiptNoWrite an atomic private run receipt (default: false)
timeoutNoRequest timeout (default: 1m0s)
no-cacheNoBypass response cache (default: false)
no-colorNoDisable colored output (default: false)
no-inputNoDisable all interactive prompts (for CI/agents) (default: false)
no-learnNoDisable the teach/recall learning loop for this invocation (default: false)
resourceNoResource ID — repeat for multiple (required)
idempotentNoTreat already-existing create results as a successful no-op (default: false)
rate-limitNoMax requests per second (0 to disable; default auto — pace to server rate-limit headers) (default: auto)
data-sourceNoData source for read commands: auto (live with local fallback), live (API only), local (synced data only) (default: auto)
no-validateNoSuppress teach-time resource-shape validation (warnings to teach.log) (default: false)
playbook-fileNoOptional path to a JSON playbook recording the CLI choreography for this query family
playbook-jsonNoOptional inline JSON playbook (mutually exclusive with --playbook-file; for agents without filesystem access)
resource-typeNoResource type (required; e.g. matches a row in the local resources table)
client-profileNoSelect the tenant-gated client profile (env: ANKIWEB_CLIENT_PROFILE)
human-friendlyNoEnable colored output and rich formatting (default: false)
playbook-notesNoOptional inline gotchas/workarounds for this query family (stored alongside the playbook)
playbook-notes-fileNoOptional path to a markdown file with playbook notes
allow-partial-failureNoDowngrade response-body partial-failure (e.g. partialFailureError) to a warning instead of a non-zero exit (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare that this is a non-read-only, non-destructive operation, so the agent knows it performs a write. The description adds useful behavioral context by saying it is LLM-fired and silent, implying background invocation and minimal user-facing output. It does not explain persistence, validation behavior, or side effects beyond what the annotations provide.

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

Conciseness5/5

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

The description is a single tightly written sentence with the core action front-loaded. There is no wasted text, and the parenthetical conveys invocation context efficiently.

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

Completeness2/5

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

For a tool with 32 parameters, multiple sibling teach/recall tools, and no output schema, the description is extremely thin. It does not explain what gets stored, how validation works, or how it relates to teach_lookup and teach_playbook, leaving substantial contextual gaps despite the rich schema.

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 schema already documents all 32 parameters in detail. The description adds no parameter-level meaning beyond what the schema provides, making the baseline 3 appropriate.

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 states a specific action and object: recording a query-to-resource mapping for later recall. The parenthetical '(LLM-fired, silent)' further identifies the intended invocation mode. It does not explicitly distinguish itself from sibling tools such as teach_lookup, teach_pattern, or teach_playbook, which keeps it from a 5.

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

Usage Guidelines2/5

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

The description implies usage through 'for future recall' and '(LLM-fired, silent)', but it gives no explicit guidance on when to use this tool versus teach_lookup, teach_pattern, teach_playbook, or learnings_confirm. An agent must infer the intended situation from the name and sibling names alone.

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