Aller au contenu

Tools · Certificates

MCP tools for certificates: listing, creating, duplicating and editing templates (from the platform default or with the brand's art, with the preview in the conversation), activating, who issues in the space, issuing to people, groups and tags, resending the e-mail, retrying what failed, revoking, reissuing and deleting, and your own certificates.

Cet article n’a pas encore été traduit. Vous lisez la version en anglais.

Everything the Certificates space does, from the conversation: building the template (with the preview as an image, so you can check it first), activating it, issuing to a whole class and looking after what has already been issued. Revoking and deleting ask for your confirmation. Issuing runs on the first call, so the assistant first does a dry run (dry_run) that says how many people receive it and who is left out.

Each tool carries a badge: Read-only changes nothing, Changes creates or changes something right away, and Asks to confirm only acts after your yes to a summary. See Money and confirmation.

In short

ToolWhat it doesMinimum roleType
list_certificate_templatesA Certificates space's templatesModerator, finance or adminRead-only
get_certificate_templateOne template, with the preview as an imageModerator, finance or adminRead-only
create_certificate_templateCreates a template, from the platform default or with the brand's artModerator, finance or adminChanges
update_certificate_templateChanges texts, signers, boxes and the artworkModerator, finance or adminChanges
activate_certificate_templateActivates or archives a templateModerator, finance or adminChanges
issue_certificateIssues to people, groups and tags, after a dry runModerator, finance or adminChanges
list_issued_certificatesThe issued ones, with status and searchModerator, finance or adminRead-only
revoke_certificateRevokes a certificateAdminAsks to confirm
reissue_certificateIssues it again with the current nameAdminChanges
delete_certificateDeletes a revoked or failed oneAdminAsks to confirm
duplicate_certificate_templateCopies a template as a new draftModerator, finance or adminChanges
update_certificate_space_settingsWho issues in the space: the team or only adminsAdminChanges
resend_certificate_emailSends the certificate e-mail againModerator, finance or adminChanges
retry_certificateRetries a certificate that failedModerator, finance or adminChanges
list_my_certificatesYour certificates, with code and linksAnyRead-only
set_certificate_indexingShows or hides one of your certificates in search enginesAnyChanges
list_certificate_fontsThe fonts a template can useModerator, finance or adminRead-only
get_certificate_batchThe progress of a batch issueModerator, finance or adminRead-only

list_certificate_templates

Read-only

List certificate templates. The templates of a Certificates space, with name, slug, type and status. Role: whoever manages templates in the space (moderator, finance or admin, per Who issues).

ParameterTypeRequiredDescription
spaceid or linkNoThe Certificates space. Without it, the community's only one
statusDRAFT, ACTIVE, ARCHIVEDNoDraft, active or archived
qtextNoSearch by template name

Returns: the templates, with id, name, slug, type (PLATFORM, the platform default, or IMAGE, your own artwork) and status. Only active templates can issue.

Ask like this: "Which certificate templates are active?"

Notes: Without space and without status, the owner and admin get the active templates of every Certificates space, platform default first, with each one's space (space). The moderator still gives the space. This is what the assistant uses to pick a course's template (update_course).

get_certificate_template

Read-only

View certificate template. A template with its texts, signers and boxes, and the preview as an image, which shows up in the conversation. Role: whoever manages templates.

ParameterTypeRequiredDescription
templateid or slugYesThe template
spaceid or linkNoThe Certificates space

Returns: the template and the preview image, with a test name.

Ask like this: "Show me how the Course completion template looks."

create_certificate_template

Changes

Create certificate template. Creates a template as a draft and returns the preview as an image, in the conversation, for you to check. Role: whoever manages templates in the space.

ParameterTypeRequiredDescription
nametextYesThe template's internal name
titletext, up to 255YesThe printed title, e.g. Certificate of completion
typePLATFORM, IMAGENoDefault: PLATFORM, Memberfy's design with the community's logo and colors. IMAGE uses your brand's artwork
descriptiontext, up to 5,000NoThe text, with {nome}, {assunto} and {cargaHoraria}. A passage in square brackets disappears when its variable is empty: "concluiu[ {assunto}], com carga de {cargaHoraria} horas"
workload_hoursnumberNo
slugtextNoThe template's short address
language, timezonetextNoE.g. pt-BR, America/Sao_Paulo. Default: the community's
signerslist, up to 2NoEach with name, role and the signature as signature_url or signature_base64: a PNG up to 1200×600, ideally with a transparent background. On IMAGE it prints in the signer1Signature or signer2Signature box
image_url or image_base64link or fileFor IMAGEThe artwork, PNG or JPEG, in A4 landscape (297×210 mm, 1.414:1), at least 2,000 px wide; 3508×2480 recommended. Up to 50 MB by link, 5 MB as a file. A different ratio is never stretched: it is centered, the excess is cut off and a box in the cut strip is refused
layoutlist of boxesNoIMAGE only: where each field goes (recipientName, issuedAt, qr, title, description, workload, subjectTitle, code, signer1, signer2), in % of the artwork, with font, size, color and alignment. Without it, the default boxes apply: the name in the center, the date at the bottom left and the QR code at the bottom right. Position and size in % of the artwork, from the top-left corner; font size in % of the page height (1 ≈ 2.1 mm ≈ 6 pt); the name shrinks down to the minimum size and then breaks into two lines; the QR is square; keep a 5% margin from the edges
fontinter, montserrat, lora, playfair-display, eb-garamond, great-vibes, noto-sansNoThe name's font in the default boxes
text_colorhex colorNoThe text color in the default boxes

Returns: the template, as a draft, and the preview image.

On IMAGE, the layout keys signer1Signature and signer2Signature print each signer's signature image (only box and align; fixed height, flexible width, resting on the bottom of the box; nothing prints without an image). With signers, the default boxes already include a signature box right above each signer's name.

Ask like this: "Create a certificate template with our brand's artwork: https://…/art.png. Title Certificate of completion."

Notes: the assistant knows these measures and gets the format right the first time; it checks the preview, shows it to you and activates the template only after you approve it. To issue, activate it with activate_certificate_template. See the recipe Create a template with the brand's art and Certificates.

update_certificate_template

Changes

Edit certificate template. Changes texts, workload, signers, layout boxes, language, time zone and the artwork. Returns the new preview. Role: whoever manages templates.

ParameterTypeRequiredDescription
templateid or slugYesThe template
The restNoThe same as create_certificate_template, except type; only what you send changes

Returns: the template and the preview image.

Ask like this: "Move the name up a little and make the date gray."

Notes: if the template has already issued certificates, its version goes up, and the certificates already issued stay as they came out.

activate_certificate_template

Changes

Activate or archive template. Activates a template (only active ones issue) or archives it. Role: whoever manages templates.

ParameterTypeRequiredDescription
templateid or slugYesThe template
spaceid or linkNo
actionactivate, archiveNoDefault: activate

Ask like this: "Go ahead and activate the template."

issue_certificate

Changes

Issue certificates. Issues certificates from an active template to people, groups and tags, with the subject and the workload. Role: whoever issues in the space.

ParameterTypeRequiredDescription
templateid or slugYesAn active template
peoplelist of profile ids, up to 1,000NoFrom list_members
groupslist of ids, up to 100NoFrom list_groups
tagslist of names, up to 100No
subjecttextNoWhat was completed, e.g. Excel from Scratch (the {assunto} in the text)
workload_hoursnumberNo
send_emailyes or noNoDefault: yes
issue_anywayyes or noNoAlso issues to people who already hold a valid certificate from this template. Default: no
dry_runyes or noNoOnly the dry run: says who receives one and who is left out, without issuing anything. Default: no
spaceid or linkNo

Returns: with dry_run: true, the dry run: how many people receive it, who is skipped and why (for example, people who already hold a valid one). Nothing is issued. Without dry_run, the issuing.

Ask like this: "Issue the completion certificate to the March class group, subject Excel from Scratch, 40 hours."

Notes: each person receives an email, which is why the assistant runs the dry run first, shows who receives one and who is left out, and only issues after your ok. Someone in more than one group or tag gets a single certificate. See the recipe Issue certificates to the class.

list_issued_certificates

Read-only

List issued certificates. The certificates of a space, filtered by template and status, with search by name or code. Role: whoever issues in the space.

ParameterTypeRequiredDescription
spaceid or linkNo
templateid or slugNo
statusPENDING, ISSUED, FAILED, REVOKEDNoGenerating, issued, failed, revoked
searchtextNoName or code
page, limitnumberNoPagination

Ask like this: "Did any certificate for the March class fail?"

For managers, each certificate carries reissuedIfDeleted (true or false), which says whether an automatic new issue would follow the deletion.

revoke_certificate

Asks to confirm

Revoke certificate. Revokes a certificate, with an internal reason. The public verification page then says it was revoked. Minimum role: admin.

ParameterTypeRequiredDescription
certificateid or linkYes
reasontextYesInternal; nobody outside sees it

Ask like this: "Revoke certificate K7Q3-9XWD-2MFA, it was issued by mistake."

reissue_certificate

Changes

Reissue certificate. Issues it again with the person's current name. The old one is revoked and linked to the new one. Minimum role: admin.

ParameterTypeRequiredDescription
certificateid or linkYes
send_emailyes or noNoDefault: yes

Ask like this: "Ana fixed her name on her profile; reissue her certificate."

delete_certificate

Asks to confirm

Delete certificate. Deletes a revoked or failed certificate. A valid certificate has to be revoked first. Minimum role: admin.

ParameterTypeRequiredDescription
certificateid or linkYes

Ask like this: "Delete the certificates that failed in yesterday's issuing."

When you delete the certificate of an event the person still qualifies for, the summary warns: "Warning: this person still qualifies for this event (confirmed attendance). After the delete, a new certificate will be issued automatically within about 15 minutes, with an email." In list_issued_certificates, reissuedIfDeleted also applies to event certificates.

For a course certificate where the person still meets the requirements, the summary the assistant shows before confirmation warns: "Warning: this person still qualifies for this course. After the delete, a new certificate will be issued automatically within about 15 minutes, with an email.". Tip: to avoid a new issue, remove the person from the course requirements first.

duplicate_certificate_template

Changes

Duplicate certificate template. Copies a template as a new draft, so you can adjust it without touching the original. Role: whoever issues in the space.

ParameterTypeRequiredDescription
template_ididYesFrom list_certificate_templates

Ask like this: "Duplicate the Certificate of completion so I can make the participation version."

update_certificate_space_settings

Changes

Change who issues certificates. Sets who issues in a Certificates space: the team (moderator, finance and up) or only admins. Minimum role: admin.

ParameterTypeRequiredDescription
spaceid, link, address or nameYes
who_can_issuestaff, adminsYes

Notes: it changes who can do what right away.

resend_certificate_email

Changes

Resend certificate e-mail. Sends the "your certificate is here" e-mail of an issued certificate again. Role: whoever issues in the space.

ParameterTypeRequiredDescription
certificateid or linkYes

Ask like this: "Ana couldn't find the certificate e-mail; send it again."

retry_certificate

Changes

Retry failed certificate. Generates again a certificate whose generation failed and, by default, sends the e-mail when it's ready. Role: whoever issues in the space.

ParameterTypeRequiredDescription
certificateid or linkYes
send_emailyes or noNoDefault: yes

list_my_certificates

Read-only

My certificates. Your certificates in the community, with the verification code and the links. Minimum role: any.

Parameters: none.

Ask like this: "Give me the link to my Excel from Scratch certificate."

set_certificate_indexing

Changes

Show certificate in search engines. Turns Show in search engines on or off on the public verification page of one of your certificates. Role: whoever received the certificate.

ParameterTypeRequiredDescription
certificate_ididYesFrom list_my_certificates
indexableyes or noYes

list_certificate_fonts

Read-only

Certificate fonts. The fonts a certificate template can use, for the fields of create_certificate_template and update_certificate_template. Minimum role: moderator, finance or admin, depending on the space.

Parameters: none.

Returns: each font's key, name, style and weights.

Ask like this: "Which fonts can I use on the certificate?"

get_certificate_batch

Read-only

Issuing progress. The progress of a batch of certificates issued together. Minimum role: moderator, finance or admin, depending on the space.

ParameterTypeRequiredDescription
batch_ididYesThe batch.id that issue_certificate returns

Returns: how many in total, pending, issued, failed and revoked, and when the batch finished.

Ask like this: "Have the class's certificates gone out?"

Notes: if some failed, the assistant suggests retry_certificate; if some are still pending, it suggests asking again.