MCP server

Institution and school integration, with separate DeanDesk employee access — the MCP server is hosted by DeanDesk. Institution connections are authorized per institution. Once connected, the tools exposed to your AI client can read and write data across the institution and any selected school, subject to the scopes and roles you grant.

DeanDesk runs a Model Context Protocol (MCP) server for AI clients that support remote MCP connections. After authorization, the client can use DeanDesk tools to look up institution details, manage memberships, work with school users and courses, manage course materials and curricula, take attendance, create invoices, edit products and pages, read documentation, and store files in the institution Shared Drive.

How authorization works

The MCP server uses OAuth 2.1 with PKCE and supports dynamic client registration. When you add DeanDesk to an MCP client, the client opens a DeanDesk authorization page in your browser. For institution or school access, sign in with your institution Identity, review the requested scopes, choose a school context when school tools are needed, and approve the client. DeanDesk employees can instead select Employee access and sign in with their registered employee Google account. Employee access does not require a school or institution selection. The tools that appear in your AI client depend on four things:

The scopes you approve
Your institution role
Your school role, when a selected school is required
The environment, because some migration tools are sandbox-only

Refresh tokens are issued when the client requests offline_access, so long-running clients can stay connected without asking you to sign in again.

How to set it up

Use the MCP endpoint provided by DeanDesk support or your institution administrator. For hosted DeanDesk environments, the endpoint is usually:

https://ai.deandesk.com/agent/mcp

Add DeanDesk as a remote MCP server

In your MCP client’s settings, create a new server named DeanDesk and enter the DeanDesk MCP endpoint. Some clients call this a remote server URL, connector URL, or streamable HTTP endpoint.

Authorize the client

The client opens the Connect DeanDesk page in your browser. Under School or institution access, click Continue with Google, or enter your Email or username and Password and click Continue. DeanDesk employees click Employee access instead. Review the requested permissions and approve only the access the client needs.

Select a school when needed

Employee connections skip this step. School-level tools require a selected school context. On the consent page, pick a school from the DeanDesk context list (you can search by school name or hostname), then click Allow access. Choose a school when you want the client to manage school users, courses, course materials, curricula, rosters, products, assignments, surveys, forms, attendance, invoices, pages, email drafts, or school settings.

Confirm the tools loaded

Return to the MCP client and refresh its tool list if needed. The DeanDesk tools that match your approved scopes and roles should now appear under the DeanDesk server.

Start with read-only scopes when testing a new client. Add write scopes only when the client needs to create, update, delete, or send data.

DeanDesk employee access

Select Employee access, sign in with the Google account registered for your active DeanDesk employee account, then select Authorize employee access. The consent page shows your employee role and the permissions for this connection. No school picker appears. Owners and employee admins can manage the employee support queue and view institution information. Read-only employees can view tickets and institutions but cannot update tickets or send replies. Institution and school accounts do not grant DeanDesk employee access. Removed employee access is enforced on existing connections; role promotions require a new authorization to grant additional permissions. Employee ticket reads include private staff notes. Public replies can send email or WhatsApp messages, so review the recipient and message before sending.

Tool	Required scope	What it does
`list_employee_support_tickets`	`employee.support:read`	Searches the employee support queue, including escalations and incoming support.
`get_employee_support_ticket`	`employee.support:read`	Reads a ticket conversation and private staff notes.
`update_employee_support_ticket`	`employee.support:write`	Updates status, priority, assignment, or links unlinked intake to an institution.
`reply_to_employee_support_ticket`	`employee.support:write`	Sends a public reply or adds a private staff note.
`list_employee_institutions`	`employee.institutions:read`	Searches the institution directory.
`get_employee_institution`	`employee.institutions:read`	Reads institution contact details, subscription information, and schools.

Employee connections expose only the employee tools allowed by your role and approved permissions. The institution and school tools below apply to institution and school connections.

Available scopes

Scopes control which tools the AI client can call.

Scope	What it grants
`institution:read`	Read institution profile, subscription, branding, and school list
`institution:write`	Update institution-level settings such as public portal visibility
`membership:read`	Read institution membership plans, memberships, and pending imports
`membership:write`	Create, update, import, link, or sync institution memberships
`school:read`	Read the selected school’s profile and basic setup
`school.settings:read`	Read selected school settings, onboarding policies, metadata fields, custom pages, blog posts, and reusable templates
`school.settings:write`	Update selected school settings, onboarding policies, metadata fields, custom pages, blog posts, and reusable templates
`students:read`	Read selected school users, course students, rosters, and roster candidates
`students:write`	Import users and add or remove roster students
`courses:read`	Read courses, course materials, curricula, course sidebar visibility, and course bulk-edit data
`courses:write`	Import, create, or update courses, course enrollments, course sidebar visibility, course materials, and curricula
`assignments:read`	Read assignments, quizzes, surveys, submissions, and analytics
`assignments:write`	Create, update, or delete assignments, quizzes, and surveys, and draft quizzes for chat review
`forms:read`	Read school forms, their questions, and form submissions
`forms:write`	Create school forms or update form settings and questions
`calendar:read`	Read academic years, terms, and calendar events
`calendar:write`	Create, update, or delete academic years, terms, and calendar events
`attendance:read`	Read course attendance sessions, per-student statuses, and attendance analytics
`attendance:write`	Take or update course attendance; manual edits override automatic video-call records
`communications:write`	Draft school emails for review, or send approved school emails
`products:read`	Read products, prices, checkout settings, booking providers, availability and sessions, product details, and program enrollments
`products:write`	Create, import, update, or add prices to products; update booking notes and complete, cancel, or mark sessions as no-show
`payroll:read`	Read payroll settings, staff and course rates, payroll records, and audit history
`payroll:write`	Update payroll settings, rates, record statuses, overrides, and ad-hoc hours, email payroll exports, and grant delegated payroll access
`financialAid:read`	Read per-user scholarship and financial aid percentages
`financialAid:write`	Set per-user scholarship and financial aid percentages
`invoices:read`	Read the school’s Stripe invoices
`invoices:write`	Create Stripe invoices, including auto-charged and recurring invoices
`files:read`	List school file-library records, read metadata, and create temporary view links
`files:write`	Upload files, update file metadata, or delete file-library records
`migration:read`	Read migration workspaces
`migration:write`	Create or update sandbox migration workspaces
`memory:read`	Browse and read institution or school Shared Drive files
`memory:write`	Create, overwrite, organize, or delete Shared Drive files and folders
`offline_access`	Issue refresh tokens so the client can stay connected without re-authentication

The scopes offered during authorization depend on your roles. School admins can receive every school scope. Teachers also receive attendance:read and attendance:write so they can take attendance for their courses. Institution Admin Read-Only identities receive financialAid:read and invoices:read alongside their other read scopes.

Available tools

Institution super-admins can discover all school-level tools allowed by their approved scopes before selecting a school. Use list_school_contexts and switch_school_context to choose a school before calling those tools. Switching schools keeps the same tool list, and subsequent calls use the newly selected school. Each call still checks your current permissions and the selected school’s environment. Institution Admin Read-Only identities and members retain their existing access limits. School connections only expose tools allowed by their approved scopes, school roles, and environment. School admins can also use DeanDesk AI for account activation, course enrollment changes, curriculum maps and reusable templates, custom user fields, global page themes and fonts, and archived-product deletion. These actions are also available in institution AI chats with a selected school and the required permissions. Destructive and bulk actions require confirmation.

Institution and memberships

Tool	Scope	What it does
`get_institution_info`	`institution:read`	Shows institution context, branding, subscription state, public portal visibility settings, and selected school context.
`update_public_portal_settings`	`institution:write`	Updates public institution home page tab visibility and which schools appear publicly. Hiding the Membership or Donate tab also disables those public pages.
`list_institution_schools`	`institution:read`	Lists schools in the institution and shows whether the token can act on them.
`list_school_contexts`	No scope required	Lists the DeanDesk schools your OAuth identity can switch this MCP connection to.
`switch_school_context`	No scope required	Switches the MCP connection to a different school. Institution-admin connections switch instantly with no reauthorization; school-admin connections go through a seamless OAuth reauthorization.
`list_membership_plans`	`membership:read`	Lists institution membership plans and term settings.
`list_institution_memberships`	`membership:read`	Lists memberships with filters for status, tier type, payment source, and pagination.
`get_institution_membership`	`membership:read`	Reads one membership record with editable details and metadata.
`update_institution_membership`	`membership:write`	Updates membership status, contact details, spouse/household details, manual dates, payment source, notes, and metadata.
`create_manual_membership`	`membership:write`	Creates a manual membership (with contact and spouse/household details) or queues it when the identity does not exist yet.
`bulk_import_memberships`	`membership:write`	Imports manual memberships in bulk (rows support contact and spouse/household details) and queues unknown identities for follow-up.
`list_pending_membership_imports`	`membership:read`	Lists pending membership imports that still need identity linking or sync resolution.
`link_pending_membership_import`	`membership:write`	Links a pending import record to an identity and creates or reuses the membership.
`sync_pending_membership_imports`	`membership:write`	Runs a sync pass over pending membership imports.

Migration

Tool	Scope	What it does
`list_migration_workspaces`	`migration:read`	Lists migration workspaces for the institution.
`create_migration_workspace`	`migration:write`	Creates a sandbox migration workspace for an institution or selected school. Sandbox only.
`update_migration_workspace`	`migration:write`	Updates migration staging data, mappings, validation summaries, or status. Sandbox only.

Shared Drive and documentation

Tool	Scope	What it does
`list_shared_drive_directory`	`memory:read`	Browses institution or school Shared Drive folders and files.
`read_shared_drive_file`	`memory:read`	Reads a Shared Drive file by ID and returns text when available plus a signed download URL.
`write_shared_drive_file`	`memory:write`	Creates or overwrites a text file in the Shared Drive.
`create_shared_drive_folder`	`memory:write`	Creates a Shared Drive folder, including intermediate folders when needed.
`delete_shared_drive_entry`	`memory:write`	Deletes a Shared Drive file or folder. Root institution and school folders cannot be deleted.
`list_docs`	No scope required	Lists DeanDesk documentation pages from the configured docs repository.
`read_doc`	No scope required	Reads one documentation page by slug, such as `finance/stripe`.
`search_docs`	No scope required	Searches documentation titles, slugs, and content.
`search`	No scope required	Searches DeanDesk documentation and returns citation-ready result IDs, titles, URLs, and snippets. Designed for clients such as ChatGPT deep research.
`fetch`	No scope required	Fetches one documentation page by ID returned from `search`, with a citation-ready URL and document text.

School users, courses, materials, curricula, and rosters

Tool	Scope	What it does
`get_school_info`	`school:read`	Reads the selected school’s profile, hostname, timezone, subscription plan, fixed sales currency, and registration policies.
`get_school_stats`	`school:read`	Reads school usage statistics: storage usage by category and active, inactive, and total student counts.
`list_users`	`students:read`	Lists selected school users with search plus role, adult/child type, active status, grade, roster, course-enrollment, admissions-track enrollment, product-purchase, and metadata filters. Results include each user’s enrolled admissions tracks.
`import_users`	`students:write`	Creates or updates up to 500 regular or child accounts with parent linking, profile fields, metadata, and course, roster, project, or form assignments. Existing accounts retain their roles and gain missing requested roles. Activation emails go only to newly created accounts and can be disabled.
`set_user_active_status`	`students:write`	Activates or deactivates a user account. This is separate from account locking; deactivation removes the user’s access, so confirm before deactivating.
`list_courses`	`courses:read`	Lists selected school courses with instructor, assistant, term, and lifecycle status details, with optional status and catalog-status filters (including upcoming).
`import_courses`	`courses:write`	Bulk-imports courses, including instructors, assistants, terms, schedules, capacity, tags, and lifecycle status.
`create_course_from_template`	`courses:write`	Creates a live course from a school course template with optional overrides for title, instructor, assistants, term, dates, schedule, capacity, enrollment code, lifecycle status, and copied content. Admin role required.
`get_course_bulk_edit_data`	`courses:read`	Loads the course spreadsheet dataset, including each course’s lifecycle status, and valid edit options.
`bulk_edit_courses`	`courses:write`	Bulk creates or updates courses, including lifecycle status changes, using the same spreadsheet save flow as the web app.
`update_course_sidebar_visibility`	`courses:write`	Shows or hides course sidebar items such as curriculum, assignments, materials, surveys, students, attendance, and gradebook.
`update_course_welcome_email`	`courses:write`	Configures the custom welcome email sent when a student is enrolled in a course. Include only the fields to change; disable sending with `enabled` set to false.
`get_course_students`	`students:read`	Lists enrolled students for a course with enrollment IDs, status, sections, and basic profile fields.
`bulk_add_course_students`	`courses:write`	Enrolls existing active student users in a course by student ID, optionally scoped to course section IDs.
`bulk_remove_course_students`	`courses:write`	Removes students from a course by deleting their enrollment records.
`update_course_student_enrollment`	`courses:write`	Updates one enrolled student’s course enrollment status.
`list_course_waitlist`	`courses:read`	Lists waitlist entries for capacity-limited courses with filters for search, course, and product.
`update_course_waitlist_capacity`	`courses:write`	Adjusts or removes a course’s capacity limit. Raising capacity automatically notifies waitlisted users.
`manual_enroll_waitlisted_user`	`courses:write`	Enrolls a waitlisted user directly without payment and clears their waitlist entry. Confirm before use.
`upload_course_image`	`courses:write`	Uploads or replaces a course image from base64-encoded JPEG, PNG, or WebP bytes.
`get_course_image`	`courses:read`	Returns a temporary signed URL for a course image.
`delete_course_image`	`courses:write`	Deletes a course image.
`list_course_materials`	`courses:read`	Lists course materials grouped by course-wide and section-specific groups.
`get_course_material`	`courses:read`	Reads one course material with content and attached file metadata.
`create_course_material`	`courses:write`	Creates one text material or one file material that uses an existing DeanDesk file.
`upload_course_material_file`	`courses:write`	Uploads a small base64-encoded file and creates a file material for a course.
`create_course_material_with_upload`	`courses:write`	Uploads a file from a URL or enabled server-local path and creates a file material for a course in one call.
`update_course_material`	`courses:write`	Updates a course material title, sections, content, file, order, publication state, or availability date.
`delete_course_material`	`courses:write`	Deletes a course material record. The uploaded file record is not deleted automatically.
`reorder_course_materials`	`courses:write`	Replaces the material order for a course.
`preview_youtube_playlist`	`courses:read`	Resolves a YouTube playlist and shows the public videos that would be imported.
`import_youtube_playlist_materials`	`courses:write`	Imports a YouTube playlist as one text material per public video.
`get_course_curriculum`	`courses:read`	Reads the complete course curriculum with units, modules, material references, and assessment references.
`replace_course_curriculum`	`courses:write`	Replaces the entire course curriculum structure.
`create_curriculum_unit`	`courses:write`	Creates a curriculum unit.
`bulk_create_curriculum_units`	`courses:write`	Creates multiple curriculum units in one tool call.
`update_curriculum_unit`	`courses:write`	Updates a curriculum unit.
`delete_curriculum_unit`	`courses:write`	Deletes a curriculum unit and its nested curriculum content.
`reorder_curriculum_units`	`courses:write`	Reorders curriculum units.
`create_curriculum_module`	`courses:write`	Creates a curriculum module inside a unit.
`bulk_create_curriculum_modules`	`courses:write`	Creates multiple curriculum modules or lessons in one tool call.
`update_curriculum_module`	`courses:write`	Updates a curriculum module.
`delete_curriculum_module`	`courses:write`	Deletes a curriculum module from a unit.
`reorder_curriculum_modules`	`courses:write`	Reorders modules within a unit.
`add_curriculum_material`	`courses:write`	Adds an existing course material reference to a unit or module.
`bulk_add_curriculum_materials`	`courses:write`	Adds multiple existing course material references to units or modules in one tool call.
`update_curriculum_material`	`courses:write`	Updates a curriculum material reference, such as order or required status.
`remove_curriculum_material`	`courses:write`	Removes a material reference from the curriculum without deleting the underlying material.
`reorder_curriculum_materials`	`courses:write`	Reorders material references within a unit or module.
`add_curriculum_assessment`	`courses:write`	Adds an existing assignment as an assessment reference in a unit or module.
`bulk_add_curriculum_assessments`	`courses:write`	Adds multiple existing assignments or quizzes as curriculum assessment references in one tool call.
`update_curriculum_assessment`	`courses:write`	Updates a curriculum assessment reference, such as order or required status.
`remove_curriculum_assessment`	`courses:write`	Removes an assessment reference from the curriculum without deleting the assignment.
`reorder_curriculum_assessments`	`courses:write`	Reorders assessment references within a unit or module.
`move_curriculum_item`	`courses:write`	Moves a module, material reference, or assessment reference to another curriculum parent.
`bulk_move_curriculum_items`	`courses:write`	Moves multiple modules, material references, or assessment references in one tool call.
`duplicate_curriculum_item`	`courses:write`	Duplicates a curriculum unit or module with nested curriculum references.
`list_curriculum_map_presets`	`courses:read`	Lists configurable starter structures and their supported options.
`list_curriculum_maps`	`courses:read`	Searches reusable curriculum maps owned by the selected school.
`get_curriculum_map`	`courses:read`	Reads a curriculum map with its arbitrary hierarchy and template summaries.
`create_curriculum_map`	`courses:write`	Creates a school curriculum map, optionally from a configurable starter structure. Admin role required.
`update_curriculum_map`	`courses:write`	Updates curriculum map metadata, version, or status. Admin role required.
`duplicate_curriculum_map`	`courses:write`	Creates an independent copy of a map, hierarchy, and templates. Admin role required.
`archive_curriculum_map`	`courses:write`	Archives a curriculum map without changing live courses created from it. Admin role required.
`create_curriculum_node`	`courses:write`	Adds a typed hierarchy node to a map. Admin role required.
`update_curriculum_node`	`courses:write`	Updates a hierarchy node’s reusable metadata. Admin role required.
`move_curriculum_node`	`courses:write`	Moves a node while enforcing same-map ownership and cycle prevention. Admin role required.
`reorder_curriculum_nodes`	`courses:write`	Reorders a complete set of sibling nodes. Admin role required.
`delete_curriculum_node`	`courses:write`	Deletes a node with explicit recursive-delete or child-move behavior. Admin role required.
`list_course_templates`	`courses:read`	Searches reusable course-template summaries.
`get_course_template`	`courses:read`	Reads one template, optionally including its complete reusable curriculum snapshot.
`create_course_template`	`courses:write`	Creates and places a reusable course template in a curriculum map. Admin role required.
`update_course_template`	`courses:write`	Updates reusable template metadata or curriculum content. Admin role required.
`archive_course_template`	`courses:write`	Archives a template without affecting previously instantiated courses. Admin role required.
`create_course_template_from_course`	`courses:write`	Copies reusable academic content from a live course into a new template. Admin role required.
`instantiate_course_template`	`courses:write`	Creates an independently editable live course snapshot from a template. Admin role required.
`browse_curriculum_library`	`courses:read`	Searches published DeanDesk Library curriculum.
`import_library_curriculum`	`courses:write`	Imports a public map, subtree, or template as an independent school copy. Admin role required.
`build_curriculum_map`	`courses:write`	Builds a complete nested map and its course templates in one workflow; archives the partial map if a step fails. Admin role required.
`list_rosters`	`students:read`	Lists rosters so the client can find roster IDs.
`get_roster`	`students:read`	Reads one roster, including associated courses and current students.
`create_roster`	`students:write`	Creates a roster with optional linked courses, initial students, and roster metadata.
`update_roster`	`students:write`	Updates a roster’s name, description, status, linked courses, or metadata. Providing course IDs replaces the complete linked-course set.
`get_roster_bulk_edit_data`	`students:read`	Loads the roster spreadsheet dataset: editable roster rows, linked-course options, roster metadata schema, and people options.
`bulk_edit_rosters`	`students:write`	Bulk creates or updates rosters using the same spreadsheet save flow as the web app; omitted fields on existing rosters are preserved.
`list_roster_student_candidates`	`students:read`	Finds students that can be added to a roster using roster panel filters.
`bulk_add_roster_students`	`students:write`	Adds existing students to a roster by student ID.
`bulk_remove_roster_students`	`students:write`	Removes students from a roster by student ID.
`list_course_groups`	`courses:read`	Lists course groups (named sets of courses) with their member courses. Teacher or admin role required.
`create_course_group`	`courses:write`	Creates a course group with a unique name and optional member courses. Admin role required.
`update_course_group`	`courses:write`	Updates a course group’s name, description, active status, or full course list. Admin role required.
`delete_course_group`	`courses:write`	Deletes a course group without deleting its courses. Admin role required.

For large course videos or files, use create_course_material_with_upload with a public or signed fileUrl. filePath is only for trusted local MCP deployments where MCP_ENABLE_SERVER_FILE_UPLOADS=true; hosted DeanDesk MCP servers cannot read files from an agent’s local disk.

File library

URL uploads must point directly to a downloadable file. Browser preview pages, sign-in pages, and HTML error pages are rejected. For a large file, use a reachable download URL with the upload tool that supports it. Your local computer path is not accessible to the hosted server.

Tool	Scope	What it does
`upload_file`	`files:write`	Uploads a file from a reachable download URL or base64-encoded bytes into the selected school’s file library and returns its file ID.
`list_files`	`files:read`	Lists file-library records with optional filename, author, MIME type, tag, category, date, size, and full-text filters.
`get_file_metadata`	`files:read`	Reads metadata for one file-library record.
`get_file_view_link`	`files:read`	Creates a temporary signed URL for viewing a file.
`update_file_metadata`	`files:write`	Updates editable file metadata such as filename, author, tags, and categories.
`delete_file`	`files:write`	Deletes one file-library record and its stored file object. Admin role required.

School settings and pages

Tool	Scope	What it does
`get_school_config`	`school.settings:read`	Reads branding, display settings, navigation visibility (including Programs), homepage settings, timezone, and address.
`update_school_config`	`school.settings:write`	Updates selected school configuration fields while leaving omitted fields unchanged.
`get_onboarding_policies`	`school.settings:read`	Reads registration, onboarding, parent-child enrollment, program policy Markdown, application fee, acceptance requirements, single-stream or cycle-based admissions workflow, and application experience settings.
`update_onboarding_policies`	`school.settings:write`	Updates onboarding and registration policies, including program policy Markdown, single-page application layout, terms and conditions, acceptance requirement forms and access while pending, and the post-submission donation prompt. Fee amounts are provided in cents.
`get_setup_plan`	`school:read`	Reads the shared school setup plan: discovery profile, each setup step with its status and evidence, warnings, and the current step. The same plan the Setup Assistant and the Getting Started page use.
`update_setup_profile`	`school.settings:write`	Records discovery answers on the setup plan (organization type, audience, how people join, payments, academic tools, existing website, source systems, launch date, notes).
`update_setup_step`	`school.settings:write`	Updates a setup step’s status and note (in progress, done, needs admin, skipped). The end-to-end test step can only be confirmed by an administrator in the school portal.
`get_metadata_schema`	`school.settings:read`	Reads custom user metadata field definitions.
`add_metadata_field`	`school.settings:write`	Adds a custom user metadata field.
`remove_metadata_field`	`school.settings:write`	Removes a custom user metadata field definition. Existing profile data is not automatically removed.
`list_pages`	`school.settings:read`	Lists custom school pages with status, tags, audience visibility, editor paths, and preview paths; supports status, tag, and text filters.
`read_page`	`school.settings:read`	Reads a custom page with full HTML, CSS, blocks, typography, and attributes.
`update_page`	`school.settings:write`	Updates an existing custom page by page ID, including content, template, publication state, and audience visibility.
`draft_page`	`school.settings:write`	Creates or replaces a custom HTML/CSS page draft for review and publishing.
`list_page_images`	`school.settings:read`	Lists reusable custom page images with IDs, alt text, tags, stable permalinks, preview URLs, and ready-to-paste HTML snippets.
`upload_page_image`	`school.settings:write`	Uploads a reusable image to the custom page image library from a URL or enabled server-local path and returns its permalink and HTML snippet.
`update_page_image`	`school.settings:write`	Updates a page image’s title, alt text, or tags without changing its permalink.
`delete_page_image`	`school.settings:write`	Deletes a page image. Custom pages that use its permalink stop displaying the image.
`get_page_manager_settings`	`school.settings:read`	Reads Page Manager state: header links, footer links, home page selection, global page theme, and published page candidates.
`update_header_links`	`school.settings:write`	Replaces public header navigation links, including nested dropdowns.
`update_footer_links`	`school.settings:write`	Replaces public footer links and optionally updates footer copyright text.
`configure_home_page`	`school.settings:write`	Sets the public home page to the default, programs, a product or donation page, or a published custom page. A custom home page must allow public viewing; explicitly enable making it public if needed.
`get_global_page_theme`	`school.settings:read`	Reads the global custom page CSS, uploaded global page fonts, and typography selections.
`update_global_page_theme`	`school.settings:write`	Updates global custom page CSS and typography selections using existing uploaded font IDs.
`list_builtin_page_templates`	`school.settings:read`	Discovers all built-in page templates and their draft and published states.
`get_builtin_page_template`	`school.settings:read`	Reads a built-in page template, its draft and published content, starter layouts, and supported content components. Includes the blog page, article, and feed card templates.
`update_builtin_page_template`	`school.settings:write`	Saves a built-in page template as a previewable draft, or publishes it when explicitly requested.
`publish_builtin_page_template`	`school.settings:write`	Publishes the template’s saved draft without rewriting it.
`disable_builtin_page_template`	`school.settings:write`	Restores the built-in layout while keeping the saved custom draft.
`list_blog_posts`	`school.settings:read`	Lists private draft and published summaries with pagination. Set `publishedOnly=true` to inspect the public feed with search and tag filters.
`read_blog_post`	`school.settings:read`	Reads a post’s full draft, published snapshot, slug, and publication state.
`create_blog_post`	`school.settings:write`	Creates a private draft with a title and slug, plus optional article HTML, excerpt, author, cover image, and tags.
`update_blog_post`	`school.settings:write`	Updates selected draft fields while preserving omitted fields and the published snapshot.
`publish_blog_post`	`school.settings:write`	Publishes the saved article draft or makes saved changes live.
`unpublish_blog_post`	`school.settings:write`	Removes a post from public view while keeping its editable draft.
`get_blog_feed_embed`	`school.settings:read`	Generates a reusable HTML feed component with grid/list layout, page size, and an optional tag filter.
`upload_global_page_theme_font`	`school.settings:write`	Uploads a WOFF2, WOFF, TTF, or OTF font from a reachable URL or base64-encoded file into the global page theme.
`delete_global_page_theme_font`	`school.settings:write`	Deletes an uploaded global page theme font and clears any typography selection that used it.

Blog posts and reusable templates

These are school-level tools. Select a school with admin access. Reading requires school.settings:read; saving, publishing, and unpublishing require school.settings:write. You can also manage the same content in Website → Blog in the school’s Admin Dashboard. Ask your assistant to create a blog draft with a title, URL slug, and article content. Use read_blog_post to review it and update_blog_post to revise it. Draft saves leave the live article unchanged. Request publication separately with publish_blog_post. To remove an article from public view, use unpublish_blog_post; its draft remains available. Unpublish before changing a live article’s slug. Discover reusable layouts with list_builtin_page_templates. The blog template controls /blog, blogPost controls articles, and blogCard controls cards across all feeds. Read a template’s starters and component reference with get_builtin_page_template, save edits with update_builtin_page_template, and publish the saved draft with publish_builtin_page_template. Use disable_builtin_page_template to restore the default layout without deleting the draft. To add a feed to a custom HTML page, generate a snippet with get_blog_feed_embed, then use read_page and update_page to insert it while preserving the page’s other content, styles, and publication state. Feed embeds use the shared published blogCard template. Reuse list_page_images and upload_page_image for article covers and body images; use the returned stable permalink as the image URL.

Products, discounts, communications, assignments, and surveys

Tool	Scope	What it does
`recommend_product_configuration`	`products:read`	Recommends product type and enrollment behavior, including `purpose="booking"` for scheduled sessions. Does not create records.
`list_products`	`products:read`	Lists products with IDs, slugs, public URLs, type, status, prices, tuition settings, and course or program associations, with optional active, featured, and single- or multi-type filters.
`get_product_details`	`products:read`	Reads a complete single-product view by database ID or URL slug.
`import_products`	`products:write`	Bulk-imports products and creates Stripe products and prices automatically. Price amounts are provided in cents. Physical and booking products and marketing fields are not supported by bulk import; use `create_product` and `update_product` for those.
`create_product`	`products:write`	Creates one product of any type, including booking sessions with availability and required checkout forms, and physical products with variants and stock, with full control over product fields: donation campaign settings such as goal, deadline, donor wall, form headline, intro text, and button color, plus marketing fields (featured flag, promo headline, promo expiry). Add prices separately with `add_product_price`.
`add_product_price`	`products:write`	Adds a new price to an existing product. Unit amount is provided in dollars. Currency must match the school’s fixed sales currency; omit it to use it automatically.
`update_product`	`products:write`	Updates product fields such as name, description, type, tags, images, metadata (including donation campaign settings), marketing fields (featured flag, promo headline, promo expiry), complete booking configuration, required checkout forms for program or booking products, and associations.
`list_product_membership_plans`	`products:read`	Lists active membership plan IDs available for members-only tuition product restrictions.
`bulk_update_products`	`products:write`	Updates product-page bulk edit fields for multiple existing products, including type, featured flag, and promo fields. Prices and course, program, or roster associations are not edited by this tool.
`update_product_price`	`products:write`	Updates editable price details such as nickname, billing start mode, active status, and metadata.
`archive_product_price`	`products:write`	Archives/deactivates an existing product price.
`archive_product`	`products:write`	Archives/deactivates a product and its prices, with optional subscription handling.
`delete_product`	`products:write`	Deletes an archived product from the catalog after the exact product name is supplied as confirmation. Past purchases remain available; the product must be archived first, and its URL slug is freed for reuse.
`reactivate_product`	`products:write`	Reactivates an archived product and can optionally reactivate its prices.
`list_product_donations`	`products:read`	Lists recent donations for a donation product with pagination.
`list_program_enrollments`	`products:read`	Lists enrollments across one or more products with status, user type, and pagination filters.
`list_discounts`	`products:read`	Lists discounts with IDs, active status, application type, amount, code/rule/sibling/bundle summary, subscription duration, and usage counts.
`get_discount`	`products:read`	Reads one discount’s full configuration, including rules, product/price scope, usage constraints, subscription duration, and metadata.
`get_discount_rule_fields`	`products:read`	Lists user, identity, and derived fields available for rule-based discount conditions.
`create_discount`	`products:write`	Creates code, rule-based, sibling, or bundle discounts with product/price scope and usage constraints.
`update_discount`	`products:write`	Updates an existing discount. Product and price arrays replace the existing scope when provided.
`delete_discount`	`products:write`	Permanently deletes a discount after confirmation.
`validate_discount_code`	`products:read`	Validates a manual discount code for a user and optional product or price.
`check_discount_eligibility`	`products:read`	Checks active rule-based discounts a user qualifies for, optionally scoped to a product or price.
`check_user_discount`	`products:read`	Checks whether a user qualifies for one specific discount and returns the reason.
`calculate_discount`	`products:read`	Calculates the discount amount and final price for a specific discount and price.
`draft_email`	`communications:write`	Returns a plain text email draft for MCP clients to review. Does not send or open a composer.
`send_email`	`communications:write`	Sends a school email directly to individual recipients, courses, rosters, or email lists. Requires `confirmSend=true` after you approve the final subject, body, and audience. Available in DeanDesk AI without a composer or a required draft step.
`list_assignments`	`assignments:read`	Lists assignments for a course with type, due date, points, and submission counts.
`create_assignment`	`assignments:write`	Creates a standard non-quiz assignment for a course and notifies enrolled students. Supports a grade category on courses that use category-based grading.
`update_assignment`	`assignments:write`	Updates an existing standard assignment, including its grade category on courses that use category-based grading.
`delete_assignment`	`assignments:write`	Deletes an assignment or quiz, including its submissions and curriculum assessment references.
`create_quiz_assignment`	`assignments:write`	Creates and saves a quiz assignment directly, including questions, options, correct answers, quiz settings, optional multiple submissions, and a grade category on courses that use category-based grading.
`bulk_create_quiz_assignments`	`assignments:write`	Creates multiple quiz assignments in one tool call, each with optional grade category, and can place each quiz into a curriculum unit or module.
`update_quiz_assignment`	`assignments:write`	Updates an existing quiz assignment directly, including multiple-submission settings, and recalculates total points when questions change.
`draft_quiz`	`assignments:write`	Prepares quiz data for the DeanDesk chat interactive editor; non-chat MCP clients should use the direct quiz tools.
`get_assignment_submissions`	`assignments:read`	Reads staff-facing assignment or quiz submissions with class performance, question analytics, and per-student attempt history.
`get_course_gradebook`	`assignments:read`	Reads the complete staff-facing gradebook for one course: grading mode, students, gradebook columns, column averages, per-student grades, and submitted final grades.
`list_surveys`	`assignments:read`	Lists course surveys with due dates, question counts, anonymous-response setting, and multiple-submission setting.
`get_survey`	`assignments:read`	Reads one survey and its questions; teachers and admins also receive staff-facing analytics when available.
`create_survey`	`assignments:write`	Creates a course survey with multiple choice, rating, or short-answer questions and no grades or correct answers.
`update_survey`	`assignments:write`	Updates survey metadata, questions, Keep Responses Anonymous, due date, section, or multiple-submission settings.
`get_survey_analytics`	`assignments:read`	Reads survey submissions and analytics, including class aggregates, rating distributions, answer summaries, and per-user timelines.

Forms

School forms are the application, acceptance, and general-purpose forms created in the Form Manager — distinct from course surveys. Repeatable groups support short answer, long answer, checkboxes, and dropdown fields. Read the existing form before replacing questions so you preserve the question IDs and questions you want to keep.

Tool	Scope	What it does
`list_forms`	`forms:read`	Lists the school’s forms with status, visibility, dates, and admissions settings. Teacher or admin role required.
`get_form`	`forms:read`	Reads one form’s full definition, including every question in order. Teacher or admin role required.
`create_form`	`forms:write`	Creates a form with multiple choice, short answer, long answer, email, upload, signature, checkboxes, dropdown, or repeatable-group questions. Payment questions, contact-list enrollment, and account-creation or admissions settings stay in the Form Manager. Teacher or admin role required.
`update_form`	`forms:write`	Updates form settings and/or replaces the question set; questions omitted from the replacement list are deleted. Teacher or admin role required.
`list_form_submissions`	`forms:read`	Lists a form’s submissions as a summary without raw answers. Admin role required.
`get_form_submission`	`forms:read`	Reads one submission’s answers with long answers truncated and file or payment answers summarized. Admin role required.

Booking sessions

Booking sessions are products with type="booking". Both MCP clients and DeanDesk AI use the same booking tools in the selected school. Read tools require products:read; management actions require products:write and an administrator role. Institution identities must select a school and have its administrator permissions. Booking lists use the selected school’s live/test payment environment, and the backend continues to enforce record permissions and state transitions.

Tool	Required scope	What it does
`list_booking_providers`	`products:read`	Lists eligible teacher and administrator provider IDs.
`get_booking_slots`	`products:read`	Reads available times for a booking product over a date range of up to 31 days. Does not reserve a slot.
`list_bookings`	`products:read`	Lists up to 200 sessions, with upcoming, past, cancelled, or payment-processing views. Temporary unpaid holds are excluded.
`get_booking`	`products:read`	Reads a session’s actual status, payment status, details, and notes.
`update_booking`	`products:write`	Updates notes, location, or meeting link. Cannot change the provider, session time, payment, or confirmation status.
`cancel_booking`	`products:write`	Cancels a confirmed session, removes calendar events, and notifies both parties. Does not issue a refund.
`complete_booking`	`products:write`	Marks a paid or free confirmed session completed and sends its completion notification. Does not charge the customer.
`mark_booking_no_show`	`products:write`	Marks a paid or free confirmed session as no-show. Does not charge the customer.

Use recommend_product_configuration with purpose="booking", select a provider with list_booking_providers, and create the product with create_product. Its booking object controls provider, IANA timezone, weekly hours, duration, buffers, advance limits, daily cap, meeting details, effective dates, and calendar conflict checks. All durations and advance limits use minutes. Add pricing separately with add_product_price, using billingType="one_time" or isFree=true. Booking products cannot be bulk imported or converted through bulk updates. Attach a public, active form from the same school using requiredPurchaseFormId; checkout forms support short answers, long answers, and multiple choice, but not uploads. Customers choose a session and time at /bookings, enter contact details, and complete the form during shared checkout. Paid bookings are confirmed only after payment succeeds; free sessions confirm after completed free checkout. Reading slots, creating products, and processing payments do not establish confirmation. For configuration changes, first read get_product_details, preserve unchanged fields, and send the complete booking object to update_product. Availability belongs to the product editor at /admin/finance/products; session management is at /admin/bookings. Legacy availability records and manual unpaid confirmation are not part of this flow. Get explicit confirmation identifying the session before cancellation, completion, or no-show changes. Completion notes are included in customer notifications. Handle any refund separately.

Academic calendar

Tool	Scope	What it does
`list_academic_years`	`calendar:read`	Lists academic years with names and date ranges, with an optional name filter.
`create_academic_year`	`calendar:write`	Creates an academic year with a name, start date, and end date. Teacher or admin role required.
`update_academic_year`	`calendar:write`	Updates an academic year’s name or date range. Teacher or admin role required.
`delete_academic_year`	`calendar:write`	Deletes an academic year, cascading to its terms and related course events. Admin role required.
`list_terms`	`calendar:read`	Lists terms, optionally filtered by academic year or name.
`create_term`	`calendar:write`	Creates a term inside an academic year’s date range. Teacher or admin role required.
`update_term`	`calendar:write`	Updates a term’s name or dates within its academic year. Teacher or admin role required.
`delete_term`	`calendar:write`	Deletes a term, cascading to events for courses in that term. Admin role required.
`list_calendar_events`	`calendar:read`	Lists calendar events with date, type, course, calendar, visibility, and free-text filters.
`create_calendar_event`	`calendar:write`	Creates a calendar event, including all-day events like holidays. Teacher or admin role required.
`update_calendar_event`	`calendar:write`	Updates an existing calendar event’s details, dates, or attendees. Teacher or admin role required.
`delete_calendar_event`	`calendar:write`	Deletes a calendar event. Teacher or admin role required.

Attendance

Attendance tools are available to school admins and teachers.

Tool	Scope	What it does
`get_course_attendance`	`attendance:read`	Lists a course’s attendance sessions with per-student statuses (Present, Tardy, Excused, Unexcused), summary counts, and the attendance rate. Entries recorded automatically from video calls and manual overrides are flagged.
`record_course_attendance`	`attendance:write`	Takes attendance for a course date or updates statuses on an existing session. Tardy entries can include optional minutes late. Manual edits override automatic video-call records.
`get_attendance_analytics`	`attendance:read`	Reads school- or course-level attendance metrics for a range of up to 90 days: overall counts, a daily breakdown, and a per-student breakdown when scoped to a course.

Invoices and financial aid

Financial aid rate tools require an institution Identity in addition to the selected school, and changes are limited to Super Admin identities or school admins granted financial aid access. Admin Read-Only identities can read aid rates and invoices.

Tool	Scope	What it does
`list_financial_aid_rates`	`financialAid:read`	Lists users with their scholarship and financial aid percentages — the share of invoice line pricing waived for each user.
`set_financial_aid_rates`	`financialAid:write`	Sets a user’s scholarship and financial aid percentages (each 0-100, combined at most 100). New rates apply to future invoices only.
`list_invoices`	`invoices:read`	Lists the school’s Stripe invoices, newest first, with status and customer filters plus cursor pagination.
`create_invoice`	`invoices:write`	Creates a Stripe invoice for one user: emailed with a hosted payment link, or charged automatically to the customer’s saved payment method, with optional draft delivery and recurring schedules. Applies the user’s financial aid rates by default. Children are billed through their parent.

create_invoice bills real money and can charge a saved payment method immediately. Review the recipient, line items, and delivery mode carefully before approving the call.

Time and payroll

Payroll tools require an institution Identity in addition to the selected school: Super Admin identities can read and write, and Admin Read-Only identities can read. School-only sessions do not see these tools. See Time and payroll.

Tool	Scope	What it does
`get_payroll_settings`	`payroll:read`	Reads pay period type, processed day, default teacher attendance, and the additional-hours logging setting.
`update_payroll_settings`	`payroll:write`	Updates payroll settings. Changes affect how future pay periods are computed.
`list_payroll_rates`	`payroll:read`	Lists staff rates: hourly rate and per-period pay per staff member and role.
`update_payroll_rates`	`payroll:write`	Updates a staff member’s hourly rate and per-period pay for a role.
`list_payroll_course_rates`	`payroll:read`	Lists per-course pay settings, including unpaid courses and per-staff overrides.
`update_payroll_course_rate`	`payroll:write`	Marks a course paid or unpaid and sets per-staff overrides for hours, rate, and notes.
`list_payroll_records`	`payroll:read`	Lists payroll records for a pay period with status, hours, and gross pay per staff member.
`update_payroll_record_status`	`payroll:write`	Verifies or marks paid one or more payroll records, with an optional note.
`update_payroll_record_override`	`payroll:write`	Overrides a record’s hours, rate, or total with a note. Omitted values reset to calculated amounts.
`add_payroll_ad_hoc_hours`	`payroll:write`	Adds ad-hoc hours to a payroll record: date, hours, optional rate, and description.
`get_payroll_record_audit`	`payroll:read`	Reads the audit history for a payroll record.
`export_payroll_records`	`payroll:write`	Emails a CSV or PDF payroll export for one pay period as an attachment to selected school admins. This sends email — confirm the format, included statuses, and recipient list first.
`list_payroll_access`	`payroll:read`	Lists which school admins can view payroll and whether their access comes from an institution role or a delegated grant.
`grant_payroll_access`	`payroll:write`	Grants a school admin delegated payroll view access. This exposes staff compensation data — confirm the admin before approving.

Payroll write tools change staff compensation data. Review the intended change carefully before approving a write.

Support tickets

School tools manage tickets in the selected school and require a school User with the admin role. Institution tools manage tickets across the current institution, without requiring a selected school: Super Admin Identities can read and write, while Admin Read-Only Identities can only read. School and institution assignments use different account IDs.

Tool	Scope	What it does
`list_school_support_tickets`	`support:read`	Searches the selected school’s queue by status, assignment, escalation, or text. Returns 50 tickets per page, queue counts, and school admin User IDs for assignment. Defaults to active tickets; use `status: "all"` to include resolved and closed tickets.
`get_school_support_ticket`	`support:read`	Reads a ticket’s conversation, private notes, assignment, and escalation.
`create_school_support_ticket`	`support:write`	Submits a ticket as the connected school User. That User is the requester; this does not submit on another person’s behalf.
`update_school_support_ticket`	`support:write`	Changes status, priority, or `schoolAssignedTo`. Use a school admin User ID, or `null` to clear assignment.
`reply_to_school_support_ticket`	`support:write`	Sends a public reply or adds a private staff note. You must specify `internal: false` for a public reply or `internal: true` for a private note.
`escalate_school_support_ticket`	`support:write`	Escalates a ticket to DeanDesk employees with a reason.
`list_institution_support_tickets`	`institution.support:read`	Searches across the institution by school, requester Identity, staff assignment, status, priority, type, tag, or text. Supports overdue and escalated queues and pagination. Includes all statuses unless filtered; summary counts describe the returned page.
`get_institution_support_ticket`	`institution.support:read`	Reads an institution ticket’s conversation, private notes, assignment, and escalation.
`list_institution_support_staff`	`institution.support:read`	Finds staff Identity IDs for institution ticket assignment.
`create_institution_support_ticket`	`institution.support:write`	Creates a ticket, optionally linked to a school, requester Identity, and staff Identity, with an optional initial private note.
`update_institution_support_ticket`	`institution.support:write`	Changes ticket details, status, priority, tags, linked school/requester, or `assignedToId`. Assignment uses an institution Identity ID; `null` clears it.
`reply_to_institution_support_ticket`	`institution.support:write`	Sends a public reply or adds a private staff note, with an explicit `internal` choice.
`escalate_institution_support_ticket`	`institution.support:write`	Escalates a ticket to DeanDesk employees with a reason.

Read the ticket before changing it. To resolve or reopen it, use the appropriate update tool with status: "resolved" or status: "open". Public replies set the status to waiting_on_member; private notes preserve the current status. Public replies can send email or WhatsApp to the requester. Ticket creation, updates, and escalation can also notify staff or the requester. For example: “List overdue institution support tickets,” “Assign this school ticket to an admin,” or “Add a private note explaining what we checked.” Review the intended audience before approving a reply.

Existing MCP connections may need to reconnect and authorize the new support scopes before these tools appear. Service agents can use school support tools with explicit support scopes and school admin access. Institution support tools require an authenticated institution Identity.

Best practices

Grant the minimum scopes needed for the task.
Use a dedicated client name for each MCP client so you can revoke clients independently.
Review write actions in your institution audit history.
Read existing records before asking the client to update or delete them.

MCP tools that send communications or modify DeanDesk data act on your institution’s behalf. Treat client authorizations like API keys and grant write scopes only to clients you trust.

Get Started

School onboarding

Institution Management

Setup

Learning Management

Teaching a course

Student Management

Communication

Finance

Reports & Analytics

Integrations

Mobile App

How authorization works

How to set it up

DeanDesk employee access

Available scopes

Available tools

Institution and memberships

Migration

Shared Drive and documentation

School users, courses, materials, curricula, and rosters

File library

School settings and pages

Blog posts and reusable templates

Products, discounts, communications, assignments, and surveys

Forms

Booking sessions

Academic calendar

Attendance

Invoices and financial aid

Time and payroll

Support tickets

Best practices

​How authorization works

​How to set it up

​DeanDesk employee access

​Available scopes

​Available tools

​Institution and memberships

​Migration

​Shared Drive and documentation

​School users, courses, materials, curricula, and rosters

​File library

​School settings and pages

​Blog posts and reusable templates

​Products, discounts, communications, assignments, and surveys

​Forms

​Booking sessions

​Academic calendar

​Attendance

​Invoices and financial aid

​Time and payroll

​Support tickets

​Best practices

How authorization works

How to set it up

DeanDesk employee access

Available scopes

Available tools

Institution and memberships

Migration

Shared Drive and documentation

School users, courses, materials, curricula, and rosters

File library

School settings and pages

Blog posts and reusable templates

Products, discounts, communications, assignments, and surveys

Forms

Booking sessions

Academic calendar

Attendance

Invoices and financial aid

Time and payroll

Support tickets

Best practices