EduBase MCP Server

Official

Overview Schema Source Related Servers Discussions Admin

edubase_get_exam_settings

Read-onlyIdempotent

Retrieve exam configuration settings, including grading, results viewing, and export options. For surveys, grading and results viewing settings are omitted.

Instructions

Get the settings of an exam. Surveys are never graded and their results cannot be viewed later, so the grading and the results viewing settings are not returned for them. The columns of the results export cannot be configured for surveys either, only the format and the ordering of the exported file.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`exam`	Yes	exam identification string

Output Schema

TableJSON Schema

Name	Required	Description	Default
`exam`	Yes
`archive`	Yes
`grading`	No
`pausable`	Yes
`roundtime`	Yes
`timelimit`	Yes
`hide_grade`	No
`export_sort`	Yes
`hide_points`	No
`nonblocking`	Yes
`results_url`	No
`export_stats`	No
`freeze_round`	Yes
`results_page`	No
`view_results`	No
`export_format`	Yes
`export_gender`	No
`export_points`	No
`export_skills`	No
`export_answers`	No
`export_suspicion`	No
`show_in_lasthour`	No
`export_attendance`	No
`grading_threshold`	No
`view_results_start`	No
`hide_ingame_results`	No
`export_custom_fields`	No
`export_finished_only`	No
`view_results_identifier`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed29 schema fields changedv2.0.0Sep 15, 2026

removedOutput schema / properties / archive / description

Removed value: -"the users who already have a result can be archived"

removedOutput schema / properties / exam / description
```
Removed value: -"exam identification string"
```

removedOutput schema / properties / export_answers / description

Removed value: -"the answers given by the examinees are exported (never returned for surveys)"

removedOutput schema / properties / export_attendance / description

Removed value: -"the attendance of the examinees is exported, read only as the attendance is configured together with its source on the interface (never returned for surveys)"

removedOutput schema / properties / export_custom_fields / description

Removed value: -"the user data fields filled in by the examinees are exported (see edubase_get_exam_fields), never returned for surveys"

removedOutput schema / properties / export_finished_only / description

Removed value: -"only the examinees who finished their test are exported (never returned for surveys)"

removedOutput schema / properties / export_format / description

Removed value: -"format of the exported results file (csv: semicolon separated values, xlsx: Excel 2007+ workbook)"

removedOutput schema / properties / export_gender / description

Removed value: -"the gender of the registered examinees is exported (never returned for surveys)"

removedOutput schema / properties / export_points / description

Removed value: -"the points scored on every question are exported (never returned for surveys)"

removedOutput schema / properties / export_skills / description

Removed value: -"the skill results of the examinees are exported, only exported when the Quiz set of the exam has skills (never returned for surveys)"

removedOutput schema / properties / export_sort / description

Removed value: -"ordering of the examinees in the exported results file (default: the same order they are listed in on the users page of the exam, name: by the name of the examinees)"

removedOutput schema / properties / export_stats / description

Removed value: -"the statistics of every question are exported (never returned for surveys)"

removedOutput schema / properties / export_suspicion / description

Removed value: -"the suspicious test taking indicator is exported (never returned for surveys)"

removedOutput schema / properties / freeze_round / description

Removed value: -"the current round of the exam is frozen, no new round can be started"

removedOutput schema / properties / grading / description

Removed value: -"grading of the exam, the code of the grading preset in use, \"custom\" for a manually configured grading, or \"none\" when grading is disabled, null if the setting of the Quiz set is used (never returned for surveys)"

removedOutput schema / properties / grading_threshold / description

Removed value: -"threshold of the grading in percentage (only present if a threshold is configured for the exam)"

removedOutput schema / properties / hide_grade / description

Removed value: -"the grade is hidden on the results page"

removedOutput schema / properties / hide_ingame_results / description
```
Removed value: -"the results are hidden while the test is taken"
```

removedOutput schema / properties / hide_points / description

Removed value: -"the points are hidden during the test and on the results page"

removedOutput schema / properties / nonblocking / description

Removed value: -"exam accounts are exclusively assigned to the exam and cannot be assigned to other exams during the exam period"

removedOutput schema / properties / pausable / description

Removed value: -"tests can be paused and continued later during the exam period"

removedOutput schema / properties / results_page / description

Removed value: -"the examinees are redirected to the results page after the test"

removedOutput schema / properties / results_url / description

Removed value: -"URL where examinees can look up their own results with the identifier (only present if the identifier based results page is available)"

removedOutput schema / properties / roundtime / description

Removed value: -"time limit of a single question in seconds (as a number), turn based Quiz sets only, null if the setting of the Quiz set is used, or 0 if there is no time limit"

removedOutput schema / properties / show_in_lasthour / description

Removed value: -"the results are only shown in the last hour of the exam"

removedOutput schema / properties / timelimit / description

Removed value: -"time limit of the whole test in seconds (as a number), null if the setting of the Quiz set is used, or 0 if there is no time limit"

removedOutput schema / properties / view_results / description

Removed value: -"when the examinees can see their results (after: right after the test is submitted, until the end of the exam, always: any time during the exam period, the examinees can log back in to see their results, datetime: after the test is submitted, and again from the start of the results viewing period, datetime_blind: only in the results viewing period, the solutions and the details of the evaluation are hidden right after the test, manual: only after the result is published separately, test by test, none: never), never returned for surveys"

removedOutput schema / properties / view_results_identifier / description

Removed value: -"label of the custom user data field the examinees can look up their results with (only present if view_results is datetime or datetime_blind)"

removedOutput schema / properties / view_results_start / description

Removed value: -"start of the results viewing period (only present if view_results is datetime or datetime_blind)"

Addedv1.2.15Sep 2, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Annotations already mark the tool read-only, idempotent, and non-destructive. The description adds meaningful behavioral nuance: surveys are never graded, grading/results viewing settings are omitted for them, and results export columns cannot be configured for surveys. This goes beyond the annotations without contradicting them.

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 terse and well-structured: the core purpose is stated first, followed by relevant edge-case behavior for surveys. Every sentence contributes useful information without redundancy or filler.

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?

This is a low-complexity, single-parameter read-only tool with a rich output schema and annotations covering safety. The description clearly explains the main behavior and important survey-specific exclusions, so an agent has sufficient context to invoke it correctly.

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 only parameter, 'exam', is fully described in the schema as 'exam identification string', so schema description coverage is 100%. The description does not add additional meaning about the parameter's format, domain, or constraints, which is acceptable because the schema already covers it.

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 opens with the verb and resource explicitly: 'Get the settings of an exam.' The tool name and title reinforce this, and the survey-specific caveats show it is about retrieving settings rather than mutating them. It is clearly distinguishable from mutation siblings like edubase_patch_exam_settings.

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 usage is for retrieving exam settings but does not explicitly state when to use this tool instead of alternatives or name any sibling for comparison. The survey caveats provide useful context but do not give when/when-not guidance relative to other available tools.

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

Deploy Server