Skip to main content
Glama

Study panel: grade

panel_grade
Idempotent

Used by Flash's study panel only; never call it yourself (use submit_review). Records the grade the user tapped and returns the panel's next card.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ratingYes1=Again 2=Hard 3=Good 4=Easy
card_idYesThe card the user graded.
answer_msNoHow long the card's front was on screen before the grade, in ms, as the panel measured it.
ui_localeNoThe language the host told the panel its person reads (a BCP 47 tag), sent with a page's first grade.
session_idYesThe session the panel is showing.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
cardNo
deckNoThe session's deck and tags as asked for: the tags are the header's chips, and both let the panel start the session again after allowing more new cards; start only.
goalNoThe goal the session counted toward, once the queue is empty.
tagsNo
viewYesWhich of the panel's views this is: always `study`.
weekNoThe seven study days after today and the cards due on each, once the queue is empty, for the finished screen's week.
stateYes`card` (one to show), `held` (today's limits hold the rest back), `caught_up` (nothing due), or `empty` (no cards in the scope at all).
preloadYesSigned links to warm: this card's back and the next card's front.
ui_langNoThe language the account reads Flash in (`panel_lang`); start only.
next_dueNoWhen the next cards come, once the queue is empty.
recordedYesFalse only from panel_grade, when the card had already been graded elsewhere (in the chat) and this grade was not recorded.
reviewedYesReviews recorded in this session so far, in the panel or the chat: with `remaining`, the panel's progress ("2 / 10").
site_urlYesThe site's front page, for the finished screen's "Study on the web": the cards live there too.
next_cardNoThe card expected after this one, its front only, so the panel can show it the moment a grade is tapped and record the grade behind it. The grade's own answer still says which card really comes.
remainingYesCards in the queue, this one included.
deck_labelNoThe deck as the site shows it (`Cardio › ECG`), for the panel's header; start only.
session_idYes
held_by_limitYesCards today's limits hold back.
reminders_offerNoWhether the finished screen offers reminders (panel_reminders): only once the queue is empty, and only when the server can send this account reminders it has not turned on.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / $defs / PanelGoalOut
      Added value: +{
      +  "description": "The goal a finished session counted toward, for the panel's finished\nscreen: the web's done-screen block, its words in the account's\nlanguage.",
      +  "properties": {
      +    "behind": {
      +      "description": "Behind its plan: the ring in amber.",
      +      "type": "boolean"
      +    },
      +    "caption": {
      +      "description": "How much is learned, then the days left or how to catch up.",
      +      "type": "string"
      +    },
      +    "catch_up": {
      +      "description": "New cards \"Study N more\" adds to the deck today; 0 for no button.",
      +      "format": "uint32",
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "deck": {
      +      "description": "The deck the goal is on, as boost_new_today names it.",
      +      "type": "string"
      +    },
      +    "head": {
      +      "description": "\"On track for Dec 18\", \"15 cards behind for Dec 18\".",
      +      "type": "string"
      +    },
      +    "percent": {
      +      "description": "How much of the deck is learned, out of 100: the ring.",
      +      "format": "uint32",
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "percent_label": {
      +      "description": "The share learned as text (\"40%\"), shown when there is no button.",
      +      "type": "string"
      +    },
      +    "study_more": {
      +      "description": "The button's words.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "deck",
      +    "percent",
      +    "behind",
      +    "head",
      +    "caption",
      +    "percent_label",
      +    "catch_up",
      +    "study_more"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / goal
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/PanelGoalOut"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "The goal the session counted toward, once the queue is empty."
      +}
  2. Changed3 schema fields changed
    • addedInput schema / properties / ui_locale
      Added value: +{
      +  "default": null,
      +  "description": "The language the host told the panel its person reads (a BCP 47\ntag), sent with a page's first grade.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / $defs / PanelCardOut / properties / front_lang
      Added value: +{
      +  "description": "The front's language, for its `lang`; absent when nothing says it.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / ui_lang
      Added value: +{
      +  "description": "The language the account reads Flash in (`panel_lang`); start\nonly.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  3. Changed1 schema field changed
    • changedOutput schema / required
      Previous value: -[
      -  "view",
      -  "session_id",
      -  "state",
      -  "remaining",
      -  "reviewed",
      -  "held_by_limit",
      -  "preload",
      -  "recorded",
      -  "tags",
      -  "week",
      -  "reminders_offer",
      -  "site_url"
      -]New value: +[
      +  "view",
      +  "session_id",
      +  "state",
      +  "remaining",
      +  "reviewed",
      +  "held_by_limit",
      +  "preload",
      +  "recorded",
      +  "site_url"
      +]
  4. Changed2 schema fields changed
    • addedOutput schema / properties / site_url
      Added value: +{
      +  "description": "The site's front page, for the finished screen's \"Study on the\nweb\": the cards live there too.",
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "view",
      -  "session_id",
      -  "state",
      -  "remaining",
      -  "reviewed",
      -  "held_by_limit",
      -  "preload",
      -  "recorded",
      -  "tags",
      -  "week",
      -  "reminders_offer"
      -]New value: +[
      +  "view",
      +  "session_id",
      +  "state",
      +  "remaining",
      +  "reviewed",
      +  "held_by_limit",
      +  "preload",
      +  "recorded",
      +  "tags",
      +  "week",
      +  "reminders_offer",
      +  "site_url"
      +]
  5. Changed1 schema field changed
    • addedInput schema / properties / answer_ms
      Added value: +{
      +  "default": null,
      +  "description": "How long the card's front was on screen before the grade, in ms,\nas the panel measured it.",
      +  "format": "int64",
      +  "type": [
      +    "integer",
      +    "null"
      +  ]
      +}
  6. Changed6 schema fields changed
    • addedInput schema / properties / card_id / description
      Added value: +"The card the user graded."
    • addedInput schema / properties / session_id / description
      Added value: +"The session the panel is showing."
    • addedOutput schema / $defs / DayAheadOut
      Added value: +{
      +  "description": "One study day of the week ahead.",
      +  "properties": {
      +    "at_ms": {
      +      "description": "When the study day starts, in ms since the epoch.",
      +      "format": "int64",
      +      "type": "integer"
      +    },
      +    "cards": {
      +      "description": "How many cards come due that day.",
      +      "format": "uint32",
      +      "minimum": 0,
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "at_ms",
      +    "cards"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / next_card
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/PanelCardOut"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "The card expected after this one, its front only, so the panel can\nshow it the moment a grade is tapped and record the grade behind\nit. The grade's own answer still says which card really comes."
      +}
    • addedOutput schema / properties / week
      Added value: +{
      +  "description": "The seven study days after today and the cards due on each, once\nthe queue is empty, for the finished screen's week.",
      +  "items": {
      +    "$ref": "#/$defs/DayAheadOut"
      +  },
      +  "type": "array"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "view",
      -  "session_id",
      -  "state",
      -  "remaining",
      -  "reviewed",
      -  "held_by_limit",
      -  "preload",
      -  "recorded",
      -  "tags",
      -  "reminders_offer"
      -]New value: +[
      +  "view",
      +  "session_id",
      +  "state",
      +  "remaining",
      +  "reviewed",
      +  "held_by_limit",
      +  "preload",
      +  "recorded",
      +  "tags",
      +  "week",
      +  "reminders_offer"
      +]
  7. Changed4 schema fields changed
    • addedOutput schema / $defs / NextDueOut
      Added value: +{
      +  "description": "When the next cards come, for a session with nothing left to study.",
      +  "properties": {
      +    "at_ms": {
      +      "description": "When the first of them is due, in ms since the epoch.",
      +      "format": "int64",
      +      "type": "integer"
      +    },
      +    "cards": {
      +      "description": "How many come that day.",
      +      "format": "uint32",
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "in_days": {
      +      "description": "Study days away: 1 is tomorrow, 0 later today.",
      +      "format": "uint32",
      +      "minimum": 0,
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "at_ms",
      +    "in_days",
      +    "cards"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / next_due
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/NextDueOut"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "When the next cards come, once the queue is empty."
      +}
    • addedOutput schema / properties / reminders_offer
      Added value: +{
      +  "description": "Whether the finished screen offers reminders (panel_reminders):\nonly once the queue is empty, and only when the server can send\nthis account reminders it has not turned on.",
      +  "type": "boolean"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "view",
      -  "session_id",
      -  "state",
      -  "remaining",
      -  "reviewed",
      -  "held_by_limit",
      -  "preload",
      -  "recorded",
      -  "tags"
      -]New value: +[
      +  "view",
      +  "session_id",
      +  "state",
      +  "remaining",
      +  "reviewed",
      +  "held_by_limit",
      +  "preload",
      +  "recorded",
      +  "tags",
      +  "reminders_offer"
      +]
  8. Changed3 schema fields changed
    • addedOutput schema / properties / reviewed
      Added value: +{
      +  "description": "Reviews recorded in this session so far, in the panel or the chat:\nwith `remaining`, the panel's progress (\"2 / 10\").",
      +  "format": "uint32",
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / view
      Added value: +{
      +  "description": "Which of the panel's views this is: always `study`.",
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "session_id",
      -  "state",
      -  "remaining",
      -  "held_by_limit",
      -  "preload",
      -  "recorded",
      -  "tags"
      -]New value: +[
      +  "view",
      +  "session_id",
      +  "state",
      +  "remaining",
      +  "reviewed",
      +  "held_by_limit",
      +  "preload",
      +  "recorded",
      +  "tags"
      +]
  9. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=true), and the description usefully adds that the call returns the panel's next card and is reserved for the panel UI. It does not address the mildly non-obvious idempotentHint=true on a grade-recording write, nor failure behavior, so it falls short of full disclosure.

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?

A single sentence with zero waste; the critical restriction is front-loaded before the alternative. Every clause earns its place.

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?

For a 5-param mutation tool with an output schema and full annotation coverage, the description supplies what structured fields cannot: who may call it and what the call returns. Only failure/error semantics are left unstated, which is a minor gap.

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%, including the rating scale (1=Again…4=Easy) and the meaning of answer_ms and ui_locale, so the schema carries the parameter burden. The description only loosely refers to 'the grade the user tapped' and adds no syntax or format detail beyond the schema.

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 + resource ('Records the grade the user tapped') and adds a second behavior ('returns the panel's next card'), and explicitly positions itself against the sibling submit_review. An agent can distinguish it from other write tools without opening a 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 ('never call it yourself') plus the named alternative ('use submit_review'), which is exactly the routing information an agent needs. This is a rare case where both the exclusion and the substitute are stated.

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.