Skip to main content
Glama

edubase_get_exam_fields

Read-onlyIdempotent

Get the user data fields for an exam, including built-in name, email, and phone fields plus custom fields examinees fill before starting.

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. 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)"
  2. Addedv1.2.15

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context by specifying exactly which fields are included and when they are captured ('before they start their test'), which goes beyond the structured annotations.

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?

The description is two sentences with no filler. The primary action and resource are front-loaded, and the clarifying detail about built-in versus custom fields earns its place.

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 simple read-only getter with one well-documented parameter, an output schema, and safety annotations, the description covers what the tool returns and the resource scope. Nothing an agent needs to call it correctly is missing.

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?

The schema already provides a 100% description of the single 'exam' parameter as 'exam identification string'. The description adds no parameter-level detail, but because schema coverage is complete, the baseline of 3 is appropriate.

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 clearly states the tool retrieves user data fields for an exam and enumerates what those are: built-in name/email/phone fields plus custom fields. This distinguishes it from siblings like edubase_post_exam_fields and edubase_delete_exam_fields, which perform different actions on the same resource.

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 description implies the use case — fetching the field definitions examinees encounter — but does not explicitly state when to prefer it over alternatives or mention that modifications are handled by sibling tools. An agent can infer the purpose but receives no direct guidance about exclusions or related tools.

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