Skip to main content
Glama

teach_lookup

Add a manual entity lookup row that maps an alias or value to its canonical name for a given kind, enabling accurate entity resolution.

Instructions

Install a manual entity-lookup row (kind, canonical, value)

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)
kindNoEntity kind, e.g. country, team (required, must not be a computed kind)
agentNoSet agent-friendly output defaults (--json --compact --no-input --no-color) (default: false)
plainNoOutput as plain tab-separated text (default: false)
quietNoBare output, one value per line (default: false)
valueNoValue/alias that should resolve to the canonical (required)
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)
canonicalNoCanonical entity name (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)
client-profileNoSelect the tenant-gated client profile (env: ANKIWEB_CLIENT_PROFILE)
human-friendlyNoEnable colored output and rich formatting (default: false)
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

C2.9/5.0
Behavior2/5

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

Annotations declare readOnlyHint=false and idempotentHint=false, and 'Install' is consistent with a write, but the description adds no behavioral context: it doesn't say whether existing rows are overwritten, whether confirmation is required (the 'yes' param hints at prompts), or how this interacts with the teach/recall learning loop (the 'no-learn' param).

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?

A single front-loaded clause with zero padding — the core action and its key inputs come first. It is arguably over-terse for a 25-parameter mutation tool, but that is a completeness problem rather than a conciseness one.

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 non-idempotent write tool with 25 parameters, no output schema, and a rich surrounding teach/recall ecosystem, one parenthetical is not enough. The agent is left guessing about confirmation, overwrite semantics, and return values.

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 coverage is 100%, so the 25 parameters are fully documented in structured data and the baseline is 3. The description does usefully highlight kind/canonical/value as the meaningful inputs (the schema's required list is empty even though those descriptions say 'required'), but it adds no syntax or constraint detail beyond the schema.

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?

States a specific verb ('Install') and resource ('manual entity-lookup row') plus the three key fields (kind, canonical, value), so an agent can tell it writes a manual lookup alias rather than a pattern or playbook. It does not explicitly differentiate itself from siblings teach, teach_pattern, and teach_playbook, which would be needed for 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?

There is no statement of when to use this versus teach, teach_pattern, teach_playbook, or recall — the closest siblings. No prerequisites, no exclusions, and no indication of what happens when a kind already exists.

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