Skip to main content
Glama

alphaportal_set_notification

DestructiveIdempotent

Set a student's transportation notification preferences for push and email alerts across AM/PM runs and district categories like stop radius, scans, and arrivals.

Instructions

Set a student's transportation notification preferences (push/email, per AM/PM run) across the categories the district enables: stopRadiusEntry, studentScan, backupBus, schoolArrival, stopServiced. Asks the user to confirm first: a confirmation prompt where the client supports one; otherwise the first call returns a preview of the exact payload and a confirmToken, and only a repeat call with that token proceeds (see MCP_CONFIRM_MODE). NOTE: the portal sends the whole preference set at once; categories you omit may be left unchanged or reset by the server — review the preview first.

Input Schema

NameRequiredDescriptionDefault
studentIdYesThe numeric studentId.
preferencesYesPer-category push/email toggles.
confirmTokenNoONLY for the two-step confirmation fallback (a client without MCP elicitation). The confirmToken from this same tool's phase-1 "confirmation-required" response, passed back ONLY after the user has seen that preview and explicitly approved it in chat — never on the first call, never invented, never reused. Call again with the same arguments. Ignored when the client supports elicitation.
studentOriginalIdNoThe student's originalId (from alphaportal_list_students), if known.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.1.0
    • removedInput schema / properties / confirm
      Removed value: -{
      -  "description": "Must be true to proceed. Without this, the tool returns a preview.",
      -  "type": "boolean"
      -}
    • addedInput schema / properties / confirmToken
      Added value: +{
      +  "description": "ONLY for the two-step confirmation fallback (a client without MCP elicitation). The confirmToken from this same tool's phase-1 \"confirmation-required\" response, passed back ONLY after the user has seen that preview and explicitly approved it in chat — never on the first call, never invented, never reused. Call again with the same arguments. Ignored when the client supports elicitation.",
      +  "type": "string"
      +}
  2. Changed1 schema field changedv0.4.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. First observedv0.0.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds behavior the annotations cannot: the whole preference set is submitted at once, omitted categories may be left unchanged or reset by the server, a preview payload plus confirmToken gates the real mutation, and the token must never be invented or reused. That is exactly the side-effect detail an agent needs before mutating state.

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?

The action is front-loaded in the first sentence, followed by the confirmation mechanics and a capitalized NOTE for the dangerous partial-set behavior. It is dense with parentheticals and inline caps (MCP_CONFIRM_MODE) but every sentence carries distinct operational information, so nothing is wasted.

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 destructive, nested-object mutation with no output schema, the description covers the confirmation gate, the preview/confirmToken flow, and the risk of omitted categories. It stops short of describing permissions/auth requirements, error responses, or whether partial writes are atomic, which would matter for a destructiveHint=true tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3, and the description earns an extra point by naming the five category keys the district may enable and framing each as AM/PM push/email toggles. The confirmToken semantics are reinforced but largely restate the schema's own description, so it is not fully additive.

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 first clause gives a specific verb (Set), resource (student's transportation notification preferences), and scope (push/email, per AM/PM run), then enumerates the exact category keys. This distinguishes it cleanly from the sibling read tool alphaportal_list_notifications without needing to open either schema.

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

Usage Guidelines4/5

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

It clearly states the preconditions for calling: user confirmation first, either via client elicitation or via a two-step preview/confirmToken round trip, and points to MCP_CONFIRM_MODE. It does not explicitly contrast when to use this vs. alphaportal_list_notifications or note prerequisites like district-enabled categories, so it falls short of full when/when-not routing.

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