Skip to main content
Glama

update_learning

Correct an existing lesson in place by fixing its wording or lowering its importance, so stale or over-weighted guidance can be revised without creating a duplicate.

Instructions

Fix an existing lesson in place — correct its wording or lower its importance.

    Prefer this over adding a near-duplicate when a lesson is merely wrong, stale in detail, or
    over-weighted; use ``deprecate_learning`` when it should stop firing altogether. Omitted
    fields are left unchanged (to *clear* one: ``qmx update-learning --clear-detail``).
    Returns the updated lesson, or ``None`` if ``learning_id`` does not exist.
    

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "learning_id": "<learning_id>"
    },
    "name": "update_learning"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeNo
scopeNo
topicNo
detailNo
statementNo
importanceNo
learning_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses partial-update semantics ('Omitted fields are left unchanged'), the escape hatch for clearing a field, and the None return on a missing learning_id. It does not mention permission requirements, validation limits on importance, or whether the change is reversible, which keeps it short of 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.

Conciseness4/5

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

Three tight sentences, front-loaded with the action and followed by routing and update semantics. The CLI invocation ('qmx update-learning --clear-detail') is a slightly odd artifact for an MCP tool but conveys the clear-a-field capability, so it still earns its place.

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

Completeness5/5

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

For a partial-update mutation with an output schema present, the description covers what an agent needs: what changes, what stays, how to clear, and the not-found outcome. The unmentioned fields (type, scope, topic) are self-descriptive by name and do not block a correct call.

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 0% across 7 parameters, so the description must compensate and only partly does: it maps 'wording' to statement, names importance, and explains how to clear detail. type, scope, and topic are never mentioned, and learning_id is only implicitly covered by the missing-id behavior.

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 opens with a specific verb and resource ('Fix an existing lesson in place') and immediately scopes what 'fix' means (wording, importance). It explicitly distinguishes itself from both add_learning (near-duplicate) and deprecate_learning, so an agent can pick it out of the sibling set without reading any schema.

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

Usage Guidelines5/5

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

It gives concrete selection criteria: use this when a lesson is 'merely wrong, stale in detail, or over-weighted', and route to deprecate_learning when it 'should stop firing altogether'. Both the when-to-use and the when-not-to-use alternative are named.

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