Skip to main content
Glama

Study panel: save edit

panel_save_edit
Idempotent

Used by Flash's study panel only; never call it yourself (use update_cards). Saves the panel's quick edit of a card's two fields and returns the card as it now reads.

Input Schema

NameRequiredDescriptionDefault
card_idYesThe card the panel is showing.
back_htmlYes
front_htmlYesThe note's two fields as the quick edit left them.
next_card_idNoThe card the panel expects after it, which the edit may also have changed (a sibling of the same note).

Output Schema

NameRequiredDescriptionDefault
cardYes
answerYes
preloadYesImages to fetch ahead, as a study view's.
next_cardNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / $defs / PanelAnswerOut / properties / back_lang
      Added value: +{
      +  "description": "The back's language, for its `lang`; absent when nothing says it.",
      +  "type": "string"
      +}
    • addedOutput schema / $defs / PanelCardOut / properties / front_lang
      Added value: +{
      +  "description": "The front's language, for its `lang`; absent when nothing says it.",
      +  "type": "string"
      +}
  2. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so safety and repeat-call behavior are covered structurally. The description adds useful scope context ('a card's two fields') and caller restriction, but says nothing about how next_card_id affects the mutation or what happens to fields not supplied.

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?

Two short sentences with the caller restriction and alternative front-loaded, followed by the effect. No filler or repetition.

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?

An output schema exists, so the return value needn't be re-explained, and annotations carry the safety profile. The remainder is largely complete, with only the semantics of next_card_id left thinner than ideal for a 4-parameter mutation.

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 75%, so most parameters are already documented in the schema. The description adds only that the two fields are the quick edit's front/back values and doesn't clarify next_card_id's role, so it does not meaningfully exceed the schema baseline.

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?

States a specific verb and resource ('Saves the panel's quick edit of a card's two fields and returns the card as it now reads') and explicitly names the sibling alternative (update_cards). An agent can distinguish this from update_cards and panel_edit_source without opening 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?

Gives an explicit when-not-to-use rule ('never call it yourself') plus the correct alternative ('use update_cards') and a positive condition ('Used by Flash's study panel only'). Routing is unambiguous.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.