Skip to main content
Glama

edubase_get_exam_fields

Read-onlyIdempotent

Retrieve built-in and custom user data fields for an exam, showing what information examinees must provide before starting a test.

Instructions

Get the user data fields of an exam. These are the built-in name, email address and phone number fields, and the custom fields the examinees fill in before they start their test.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
examYesexam identification string

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
examYes
nameYes
emailYes
phoneYes
fieldsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.3
    • changedOutput schema / properties / fields / items / required
      Previous value: -[
      -  "label",
      -  "type",
      -  "required"
      -]New value: +[
      +  "label"
      +]
  2. Changed19 schema fields changedv2.0.0
    • removedOutput schema / properties / email / description
      Removed value: -"the email address of the examinee is requested (false: the field is not used, true: the field is used with its default label, otherwise the custom label of the field)"
    • removedOutput schema / properties / exam / description
      Removed value: -"exam identification string"
    • removedOutput schema / properties / fields / description
      Removed value: -"the custom fields of the exam"
    • removedOutput schema / properties / fields / items / properties / description / description
      Removed value: -"description shown under the field (if set)"
    • removedOutput schema / properties / fields / items / properties / filtering / description
      Removed value: -"short labels the examinees are grouped and filtered with in the exam manager and the reports, keyed by option (select fields only, if set)"
    • removedOutput schema / properties / fields / items / properties / from / description
      Removed value: -"lowest selectable value (from-to fields only)"
    • removedOutput schema / properties / fields / items / properties / icon / description
      Removed value: -"Font Awesome icon class name of the field (if set)"
    • removedOutput schema / properties / fields / items / properties / label / description
      Removed value: -"label of the field, shown to the examinee"
    • removedOutput schema / properties / fields / items / properties / maxlength / description
      Removed value: -"maximum length of the value (free text fields only, if set)"
    • removedOutput schema / properties / fields / items / properties / minlength / description
      Removed value: -"minimum length of the value (free text fields only, if set)"
    • removedOutput schema / properties / fields / items / properties / options / description
      Removed value: -"the selectable options (select fields only)"
    • removedOutput schema / properties / fields / items / properties / pattern / description
      Removed value: -"regular expression the value has to match (free text fields only, if set)"
    • removedOutput schema / properties / fields / items / properties / required / description
      Removed value: -"the field has to be filled in"
    • removedOutput schema / properties / fields / items / properties / step / description
      Removed value: -"difference between the selectable values (from-to fields only, if set)"
    • removedOutput schema / properties / fields / items / properties / to / description
      Removed value: -"highest selectable value (from-to fields only)"
    • removedOutput schema / properties / fields / items / properties / type / description
      Removed value: -"type of the field"
    • removedOutput schema / properties / fields / items / properties / unique / description
      Removed value: -"the value has to be unique within the exam (free text fields only, if set)"
    • removedOutput schema / properties / name / description
      Removed value: -"the full name of the examinee is requested (false: the field is not used, true: the field is used with its default label, otherwise the custom label of the field)"
    • removedOutput schema / properties / phone / description
      Removed value: -"the phone number of the examinee is requested (false: the field is not used, true: the field is used with its default label, otherwise the custom label of the field)"
  3. Addedv1.2.15

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is fully covered structurally. The description adds meaningful semantic context about what the returned fields represent (built-in vs. custom examinee fields), but discloses nothing about permissions, pagination, or whether fields are exam-scoped or organization-wide.

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 sentences, zero filler, and the core purpose is front-loaded in the first clause. The second sentence is entirely additive, explaining the payload rather than restating the name.

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 an output schema present, the description need not explain return structure, and the annotations carry the safety profile; the explanation of built-in versus custom fields is the right level of added context. Only the absence of any routing hint toward sibling field tools keeps it from a 5.

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% and there is a single 'exam' parameter already documented in the schema as an 'exam identification string'. The description adds no format, ID-vs-slug detail, or lookup behavior beyond what the schema states, so the baseline of 3 applies.

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?

States a specific verb (Get) and resource (user data fields of an exam), then enumerates what those fields actually are (built-in name/email/phone plus custom examinee fields), which makes the resource concrete rather than abstract. It does not, however, distinguish itself from the sibling write operations edubase_post_exam_fields or edubase_delete_exam_fields.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance, no mention of alternatives, and no stated prerequisites. The reader must infer from the tool name alone that this is the read counterpart to post_exam_fields and delete_exam_fields; the description's note about fields examinees fill in before the test hints at context but never frames it as usage guidance.

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