Tools reference

The server offers 46 tools and 2 resources. Which ones an assistant sees depends on who is connected: signed-in people get the tools their role allows, tokens get the tools whose scope they carry. Assistants pick tools themselves; you never call them by name, but the names show up in the assistant's activity and in the CMS log.

Access in the tables below is for signed-in people. Managers and group editors are always limited to the groups they manage or edit.

AccessMeaning
AllAdmins, global editors, group editors and managers
EditorsAdmins, global editors and group editors
Admins + managersAdmins and managers
Admins + global editorsAdmins and global editors
AdminsAdmins only

Lists return 10 rows by default and at most 25 unless stated otherwise.

Content

ToolWhat it doesAccessScope
list_handbooksCatalogue of handbooks. include_drafts, include_chapters.Allread:handbooks
get_handbookOne handbook's chapters with article ids.Allread:handbooks
list_coursesCatalogue of courses. include_drafts, include_chapters.Allread:courses
get_courseOne course's chapters with article and quiz ids.Allread:courses
get_articleFull text of a chapter, announcement or event as markdown. locale.Allread:articles
search_contentFull-text search across handbooks, courses, announcements and events. query, handbook_id, in, include_past, limit. Reports match_quality.Allread:articles
create_handbookNew handbook as a draft. title, groups, locale.Editorswrite:handbooks
create_courseNew course as a draft. title, groups, locale.Editorswrite:courses
add_chapterAdd a chapter of headers, paragraphs and image galleries to a handbook or course. Live if the container is published unless is_published: false.Editorswrite:handbooks or write:courses
add_quizAttach a multiple-choice quiz (1 to 30 questions) to a course chapter. Live on published courses.Editorswrite:courses
compose_articleAppend content blocks to any article. Live on published content unless is_published: false.Editorswrite:articles

People

ToolWhat it doesAccessScope
search_usersFind employees by name or email, with groups and registration status. query, group_id, limit.Allread:users
get_userOne employee's profile: groups, roles, hire date, last activity, sync origin.Allread:users
list_groupsDepartments, professions and custom groups with managers and member counts. type, limit (default 50, max 100), include_mappings.Allread:groups
preview_audienceWho would see content with a given targeting, or an item's current audience.Allread:groups
get_org_chartThe org chart as a tree, or one person's place in it. user_id, query, group_id, node_id, depth, unplaced. Needs the org chart feature.All, once the chart is published (admins always)read:org_chart
list_external_departmentsDepartments from connected HR or scheduling systems and whether they are mapped.Adminsread:groups
list_external_groupsProfessions from connected HR or scheduling systems and whether they are mapped.Adminsread:groups
create_groupCreate a department, profession or custom group. Live immediately. name, type, is_open.Adminswrite:groups

Communication

ToolWhat it doesAccessScope
list_wallsSocial walls the connected identity can see, with post counts.Allread:walls
list_postsRecent published posts. wall_id, days (default 30), limit.Allread:posts
list_eventsUpcoming company events and calendar entries. from, to, limit.Allread:events (read:calendar_entries for calendar rows)
create_postWall post as a draft. body, wall_id.All, where the person may postwrite:posts
create_announcementAnnouncement as a draft. title, body, subtitle, groups, locale.Allwrite:announcements
create_eventCompany event as a draft. title, body, starts_at, starts_time, ends_at, location, groups, locale.Allwrite:events

Training

ToolWhat it doesAccessScope
get_journeyA journey's items in order, including journey-list tasks.Editorsread:courses
create_journeyJourney as a draft from existing courses, handbooks and forms. title, items, groups, days_after_hire, body, locale.Editorswrite:courses
assign_courseEnrol people or groups on a course. Dry run until confirm: true.Allwrite:courses
assign_journeyRoll a journey out to more groups. Dry run until confirm: true.Editorswrite:courses
list_expiring_certificatesExpired and soon-expiring certificates per employee. days (default 90), group_ids, limit (max 50).Admins + managersread:certificates
get_user_progressOne employee's onboarding, journeys, courses and certificates.Admins + managersread:stats

Forms and checklists

ToolWhat it doesAccessScope
list_formsCatalogue of forms with id, title, publication status, response count, latest response date and cms_url — the place to find a form_id. status (published default, draft, all), limit, cursor; newest first, follow next_cursor while has_more is true. Admins see every form, other users the forms they own. Whistleblower forms excluded.Admins + form ownersread:forms
get_formA form's fields, choices, targeting and response count. Whistleblower forms excluded.Editorsread:forms
get_form_responsesRecent form responses with answers. form_id, status, days (default 30), limit, cursor; newest first, follow next_cursor while has_more is true, total says how many match. Admins see everything, other users the responses of forms they own or were alarmed about — the same rule as the CMS responses list.Admins + form owners + alarm recipientsread:formresponses
get_form_alarmsAnswers that crossed an alarm threshold. days (default 7), limit. Admins see everything, other users the alarms that notify them — directly, via a group, or as owner of the form.Admins + form owners + alarm recipientsread:formresponses
list_todo_listsTo-do list templates with task counts and groups. include_drafts.Allread:todolists
get_todo_listA template's tasks.Allread:todolists
get_todo_complianceChecklist completion per department, worst first. days (default 7), group_ids. Needs the to-do feature.Admins + managersread:stats

Insights

ToolWhat it doesAccessScope
get_academy_statsOnboarding, course and journey completion. area, group_ids, per_department.Admins + managersread:stats
get_academy_overviewThe Academy dashboard figures, per department and per user. group_ids, per_department, include_users, sort, onboarding_status, limit.Allread:stats
get_engagement_statsApp usage over time, adoption per department, user and content summaries. area, granularity, scope, group_ids.Admins + global editors; managers get engagement and adoptionread:stats
get_content_reachMost or least viewed handbooks or posts. kind, months, direction, limit.Admins + global editorsread:stats
audit_contentPublished handbooks ranked by how long since they were edited. limit (max 50).Admins + global editorsread:stats
manager_hub_summaryThe Manager Hub department report. department_ids. Needs the Manager Hub feature.Admins + managersread:managerhub
get_survey_resultsAggregated survey results per question, never with names. survey_id (omit to list surveys).Admins + managersread:surveys

Media

ToolWhat it doesAccessScope
upload_mediaStore an image (base64, about 5 MB max) and get a media_id for image galleries. Only the same identity can attach it later.Allwrite:media

Open API fallback

ToolWhat it doesAccessScope
call_open_apiRaw request to any Open API endpoint when no dedicated tool fits. method, path, query, body. Responses are cut at 40 kB.Admins, signed in onlyNever offered to tokens

Resources

Resources are read-only documents an assistant can load for context.

ResourceContentsScope for tokens
monotree://localesActive content languages and the default. The valid values for every locale argument.none
monotree://org-structureDepartments, professions and custom groups with their managers, in one snapshot.read:groups

Common rules

  • Unknown argument names are rejected with the list of valid names. Validation errors list the failing fields.
  • Content blocks for add_chapter and compose_article: {"type":"header","text"}, {"type":"paragraph","markdown"}, {"type":"image_gallery","media_ids":[]}. Up to 100 blocks; the call is atomic.
  • locale must be an active language. New content gets your default content language when omitted.
  • Every content result carries a cms_url.