Skip to main content
Glama

edubase_delete_exam_certificates

DestructiveIdempotent

Halt certificate issuance for an exam while preserving configuration for later re-enabling. Existing certificates remain valid, and settings are locked during the exam.

Instructions

Stop issuing certificates for an exam. The configuration itself is kept, so the certificates can be enabled again later with edubase_post_exam_certificates. The already issued certificates are not revoked. The settings cannot be changed while the exam is locked.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
examYesexam identification string

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
examYes
notesNo
renewNo
text1No
text2No
titleNo
presetNo
enabledYes
languageNo
timezoneNo
text_dateNo
configuredYes
email_sendNo
expirationNo
show_customNo
show_resultNo
show_serialNo
custom_fieldsNo
hide_timezoneNo
result_formatNo
serial_formatNo
serial_prefixNo
branding_imageNo
branding_line1No
branding_line2No
branding_line3No
branding_line4No
manual_renewalNo
show_signatureNo
signature_leftNo
signature_userNo
show_expirationNo
signature_rightNo
signature_stampNo
branding_edubaseNo
serial_separatorNo
supervisors_onlyNo
grading_thresholdNo
custom_user_fieldsNo
serial_index_digitsNo
show_custom_brandingNo
signature_left_imageNo
signature_left_line1No
signature_left_line2No
signature_left_line3No
signature_left_line4No
signature_right_imageNo
signature_right_line1No
signature_right_line2No
signature_right_line3No
signature_right_line4No
download_automaticallyNo
show_birthdate_birthplaceNo
automatic_renewal_approvalNo
expiration_notification_emailsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed55 schema fields changedv2.0.0
    • removedOutput schema / properties / automatic_renewal_approval / description
      Removed value: -"the renewal is approved automatically, but it stays revocable (only present if show_expiration is enabled)"
    • removedOutput schema / properties / branding_edubase / description
      Removed value: -"the EduBase logo is displayed (only present if show_custom_branding is enabled)"
    • removedOutput schema / properties / branding_image / description
      Removed value: -"the uploaded logo is displayed (only present if show_custom_branding is enabled)"
    • removedOutput schema / properties / branding_line1 / description
      Removed value: -"name of the organization (only present if show_custom_branding is enabled)"
    • removedOutput schema / properties / branding_line2 / description
      Removed value: -"second line of the branding (only present if show_custom_branding is enabled)"
    • removedOutput schema / properties / branding_line3 / description
      Removed value: -"third line of the branding (only present if show_custom_branding is enabled)"
    • removedOutput schema / properties / branding_line4 / description
      Removed value: -"fourth line of the branding (only present if show_custom_branding is enabled)"
    • removedOutput schema / properties / configured / description
      Removed value: -"the certificates are configured, so they can be issued"
    • removedOutput schema / properties / custom_fields / description
      Removed value: -"custom user data displayed as extra data (only present if show_custom is enabled), the custom user data fields of the exam are identified by their label (see edubase_get_exam_fields), the data fields of the user accounts by their customer_ prefixed name"
    • removedOutput schema / properties / custom_user_fields / description
      Removed value: -"custom user data displayed together with the data of the examinee (only present if show_custom is enabled)"
    • removedOutput schema / properties / download_automatically / description
      Removed value: -"the certificate is downloaded automatically when the examinee opens the results page"
    • removedOutput schema / properties / email_send / description
      Removed value: -"the certificates are sent to the examinees in email automatically"
    • removedOutput schema / properties / enabled / description
      Removed value: -"certificates are issued for the exam, the configuration itself is only returned when the certificates are enabled"
    • removedOutput schema / properties / exam / description
      Removed value: -"exam identification string"
    • removedOutput schema / properties / expiration / description
      Removed value: -"validity period of the certificates in days (only present if show_expiration is enabled)"
    • removedOutput schema / properties / expiration_notification_emails / description
      Removed value: -"email addresses notified about the expiring certificates (only present if show_expiration is enabled)"
    • removedOutput schema / properties / grading_threshold / description
      Removed value: -"threshold of the certificates in percentage, overriding the threshold of the grading, null if the threshold of the grading is used"
    • removedOutput schema / properties / hide_timezone / description
      Removed value: -"the timezone information is hidden"
    • removedOutput schema / properties / language / description
      Removed value: -"language of the certificates"
    • removedOutput schema / properties / manual_renewal / description
      Removed value: -"the renewal has to be approved by a supervisor (only present if show_expiration is enabled)"
    • removedOutput schema / properties / notes / description
      Removed value: -"notes displayed at the bottom of the certificates"
    • removedOutput schema / properties / preset / description
      Removed value: -"identification string of the certificate preset configuring the certificates (see edubase_get_exam_certificates_presets), null if the certificates are configured manually"
    • removedOutput schema / properties / renew / description
      Removed value: -"whether the certificates can be renewed (only present if show_expiration is enabled), false: the certificates cannot be renewed, true: the certificates can be renewed any time, number: the number of days the renewal is available from, relative to the expiry (0 is the day of the expiry, negative values open the renewal before it)"
    • removedOutput schema / properties / result_format / description
      Removed value: -"format of the displayed result (only present if show_result is enabled)"
    • removedOutput schema / properties / serial_format / description
      Removed value: -"format of the serial numbers (only present if show_serial is enabled)"
    • removedOutput schema / properties / serial_index_digits / description
      Removed value: -"minimum length of the index in the serial numbers (only present if show_serial is enabled)"
    • removedOutput schema / properties / serial_prefix / description
      Removed value: -"prefix of the serial numbers (only present if show_serial is enabled)"
    • removedOutput schema / properties / serial_separator / description
      Removed value: -"separator between the parts of the serial numbers (only present if show_serial is enabled)"
    • removedOutput schema / properties / show_birthdate_birthplace / description
      Removed value: -"the birth date and the birth place of the examinee are displayed"
    • removedOutput schema / properties / show_custom / description
      Removed value: -"custom user data is displayed"
    • removedOutput schema / properties / show_custom_branding / description
      Removed value: -"custom branding (logo and organization name) is displayed"
    • removedOutput schema / properties / show_expiration / description
      Removed value: -"the certificates expire and their validity is displayed"
    • removedOutput schema / properties / show_result / description
      Removed value: -"the result of the test is displayed"
    • removedOutput schema / properties / show_serial / description
      Removed value: -"the certificates get a serial number"
    • removedOutput schema / properties / show_signature / description
      Removed value: -"signatures are displayed"
    • removedOutput schema / properties / signature_left / description
      Removed value: -"the signature of the first organizer is displayed (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_left_image / description
      Removed value: -"the uploaded image of the first signature is displayed (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_left_line1 / description
      Removed value: -"name of the first organizer (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_left_line2 / description
      Removed value: -"second line of the first signature (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_left_line3 / description
      Removed value: -"third line of the first signature (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_left_line4 / description
      Removed value: -"fourth line of the first signature (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_right / description
      Removed value: -"the signature of the second organizer is displayed (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_right_image / description
      Removed value: -"the uploaded image of the second signature is displayed (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_right_line1 / description
      Removed value: -"name of the second organizer (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_right_line2 / description
      Removed value: -"second line of the second signature (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_right_line3 / description
      Removed value: -"third line of the second signature (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_right_line4 / description
      Removed value: -"fourth line of the second signature (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_stamp / description
      Removed value: -"the uploaded stamp is displayed between the signatures (only present if show_signature is enabled)"
    • removedOutput schema / properties / signature_user / description
      Removed value: -"a signature line is displayed for the examinee (only present if show_signature is enabled)"
    • removedOutput schema / properties / supervisors_only / description
      Removed value: -"only the supervisors can issue the certificates, the examinees cannot get their own ones"
    • removedOutput schema / properties / text1 / description
      Removed value: -"text displayed under the data of the examinee, the multi line texts (text1, text2 and notes) are returned with basic HTML formatting and line breaks"
    • removedOutput schema / properties / text2 / description
      Removed value: -"text displayed under the results, above the date of the test"
    • removedOutput schema / properties / text_date / description
      Removed value: -"text displayed before the date of the test"
    • removedOutput schema / properties / timezone / description
      Removed value: -"timezone of the dates on the certificates, null if the timezone of the exam is used"
    • removedOutput schema / properties / title / description
      Removed value: -"title of the certificates"
  2. Addedv1.2.16

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds crucial context: the configuration is kept, already issued certificates are not revoked, and the lock constraint prevents changes. These are important side effects not covered by annotations. The description does not contradict annotations; it complements them. It provides a clear behavioral model beyond the structured hints.

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 three sentences, each carrying meaningful information. The first sentence states the primary action, the second explains the reversible nature and points to the alternative tool, and the third covers side effects and a constraint. No redundant phrases or filler. The most critical information is front-loaded. It is concise and well-structured.

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 tool with one parameter and an output schema, the description covers all essential aspects: what it does, side effects, reversibility, and a usage constraint. The annotations provide destructive and idempotent hints, and the description fills in the behavioral details. Nothing an agent needs to decide whether to call this tool and how it behaves 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?

Schema coverage is 100% with a single parameter 'exam' described as 'exam identification string'. The description adds no additional parameter semantics, but since the schema is fully descriptive, the baseline of 3 applies. The parameter is simple and self-explanatory; no further clarification is needed.

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 begins with a clear, specific verb and resource: 'Stop issuing certificates for an exam.' It immediately distinguishes this from other certificate-related tools by explaining the configuration is kept and certificates can be re-enabled later via edubase_post_exam_certificates. It also clarifies it does not revoke already issued certificates, which differentiates it from potential revocation tools. This is unambiguous and fully differentiates from siblings.

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?

The description explicitly names edubase_post_exam_certificates as the way to re-enable issuance, providing a clear alternative. It also states the lock constraint ('settings cannot be changed while the exam is locked'), which informs when the tool cannot be used. However, it does not explicitly contrast with tools that revoke certificates or with a full exam deletion, but the context is sufficient. The usage guidance is strong but not exhaustive.

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