Skip to main content
Glama

schedule_checkin

Set a recurring weekly check-in schedule for a client (confirm-gated). The backend will auto-create a check-in on the chosen day+time each week. dayOfWeek: 0=Sun … 6=Sat. timeOfDay: HH:MM 24-hour. Provide _id to update an existing schedule; omit to create a new one. question.type: TEXT|NUMBER|SCALE|PHOTO|YES_NO|CHOICE; helpText shows under a question; metric on a NUMBER question (WEIGHT, WAIST...) saves the answer to the client's progress chart. Editing the day/time/questions replaces the future check-ins it already created.

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": {
      "clientId": "<clientId>",
      "dayOfWeek": "<dayOfWeek>",
      "timeOfDay": "<timeOfDay>"
    },
    "name": "schedule_checkin"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmNoMust be true to actually execute. If false/omitted, returns a preview only.
clientIdYes
isActiveNo
dayOfWeekYes0=Sunday, 1=Monday … 6=Saturday
questionsNo
timeOfDayYesHH:MM in 24-hour format, e.g. 09:00
scheduleIdNoProvide to update an existing schedule

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / questions / items / properties / helpText
      Added value: +{
      +  "description": "A line shown under the question, e.g. 'Weigh first thing in the morning'",
      +  "maxLength": 300,
      +  "type": "string"
      +}
    • addedInput schema / properties / questions / items / properties / id
      Added value: +{
      +  "description": "Keep the id from a read when editing, so past answers keep matching",
      +  "type": "string"
      +}
    • addedInput schema / properties / questions / items / properties / metric
      Added value: +{
      +  "description": "NUMBER only: also save the answer to the client's progress chart as this metric. Read in the unit written in the label or answer ('Weight (lbs)', 'Waist (in)'), else the client's own unit setting.",
      +  "enum": [
      +    "WEIGHT",
      +    "WAIST",
      +    "HIP",
      +    "CHEST",
      +    "ARM",
      +    "THIGH",
      +    "NECK"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / questions / items / properties / options
      Added value: +{
      +  "description": "CHOICE only: the answers to pick from",
      +  "items": {
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "maxItems": 10,
      +  "minItems": 2,
      +  "type": "array"
      +}
    • changedInput schema / properties / questions / items / properties / type / enum
      Previous value: -[
      -  "TEXT",
      -  "NUMBER",
      -  "SCALE",
      -  "PHOTO"
      -]New value: +[
      +  "TEXT",
      +  "NUMBER",
      +  "SCALE",
      +  "PHOTO",
      +  "YES_NO",
      +  "CHOICE"
      +]
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false), it discloses that the backend auto-creates weekly check-ins and that editing day/time/questions replaces already-created future check-ins – a side effect an agent must know before calling. It does not cover permissions or what the preview response contains, so 4 rather than 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?

Dense but front-loaded: the core action and gating come first, followed by parameter notes and the side-effect warning. Some parameter notes restate the schema, and the '_id'/'scheduleId' naming slip costs clarity, keeping it below 5.

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?

With 7 parameters, a nested questions array, and no output schema, the description covers creation, updating, recurrence, the confirm-preview gate, and the replacement side effect. It leaves isActive, required-question flags, and the shape of the preview/return undocumented.

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

Parameters5/5

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

Schema coverage is 57%, and the description compensates by explaining dayOfWeek 0=Sun…6=Sat, HH:MM 24-hour timeOfDay, question.type values, helpText placement, and that metric on a NUMBER question writes the answer to the client's progress chart. The caveat is that it refers to '_id' where the schema property is 'scheduleId', which could mislead an agent.

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?

The description opens with a specific verb and resource ('Set a recurring weekly check-in schedule for a client') plus a gating qualifier, so the agent knows exactly what the tool does. It does not differentiate itself from similarly named siblings such as upsert_checkin_schedule or schedule_checkin_for_groups, which is the main gap.

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 gives a clear create-vs-update rule ('Provide _id to update an existing schedule; omit to create a new one') and notes the confirm gate, which is real when-to-use context. It stops short of naming alternatives or when-not-to-use conditions, and '_id' does not match any schema property name.

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.