Skip to main content
Glama

edubase_get_class

Read-onlyIdempotent

Retrieve class details such as title, external ID, and start/end dates by providing a class identification string.

Instructions

Get the details of a class: title, external identifier, and start and end dates.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
classYesclass identification string

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
endNo
classYes
startNo
titleYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv2.0.0
    • removedOutput schema / properties / class / description
      Removed value: -"class identification string"
    • removedOutput schema / properties / end / description
      Removed value: -"end date and time (if set)"
    • removedOutput schema / properties / id / description
      Removed value: -"external unique class identifier (if set for the class)"
    • removedOutput schema / properties / start / description
      Removed value: -"start date and time (if set)"
    • removedOutput schema / properties / title / description
      Removed value: -"title of the class"
  2. Changed3 schema fields changedv1.2.15
    • removedOutput schema / properties / name
      Removed value: -{
      -  "description": "title of the class",
      -  "type": "string"
      -}
    • addedOutput schema / properties / title
      Added value: +{
      +  "description": "title of the class",
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "class",
      -  "name"
      -]New value: +[
      +  "class",
      +  "title"
      +]
  3. Changed2 schema fields changedv1.1.2
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "class": {
      +      "description": "class identification string",
      +      "type": "string"
      +    },
      +    "end": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "end date and time (if set)"
      +    },
      +    "id": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "external unique class identifier (if set for the class)"
      +    },
      +    "name": {
      +      "description": "title of the class",
      +      "type": "string"
      +    },
      +    "start": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "start date and time (if set)"
      +    }
      +  },
      +  "required": [
      +    "class",
      +    "name"
      +  ],
      +  "type": "object"
      +}
  4. First observedv1.0.22

TDQS

A3.9/5.0
Behavior3/5

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

Annotations fully cover the safety profile (readOnlyHint=true, idempotentHint=true, destructiveHint=false), so the read-only, non-destructive behavior is already known to the agent. The description adds context about what the returned details include but does not disclose error behavior, auth needs, or other behavioral traits beyond the annotated posture. This matches the calibration anchor where annotations carry the burden and the description adds modest scope context.

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 front-loaded sentence with verb and resource followed by a compact field list. Every word earns its place; nothing is redundant or extraneous.

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 single-parameter read operation with a full annotation profile and an output schema present, nothing needed for correct invocation is missing. The description carries the selection-relevant information, and the output schema covers return-value details.

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% — the 'class' parameter is documented as 'class identification string'. The description adds no additional meaning for the parameter itself; it only enumerates the returned fields, so the baseline 3 for high schema coverage applies.

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 uses the specific verb 'Get' with the resource 'class' and enumerates the exact payload ('title, external identifier, and start and end dates'). This distinguishes it from sibling tools like edubase_get_classes (listing), edubase_get_class_members, and edubase_get_class_assignments, which cover different scopes.

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

Usage Guidelines3/5

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

The field enumeration ('title, external identifier, start and end dates') implies this is for basic class metadata, and sibling names (get_class_members, get_class_assignments) hint at alternatives. However, there is no explicit statement of when to prefer this tool vs alternatives or any exclusions, leaving routing to inference.

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

Deploy Server

Other Tools