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.
| Access | Meaning |
|---|---|
| All | Admins, global editors, group editors and managers |
| Editors | Admins, global editors and group editors |
| Admins + managers | Admins and managers |
| Admins + global editors | Admins and global editors |
| Admins | Admins only |
Lists return 10 rows by default and at most 25 unless stated otherwise.
Content
| Tool | What it does | Access | Scope |
|---|---|---|---|
list_handbooks | Catalogue of handbooks. include_drafts, include_chapters. | All | read:handbooks |
get_handbook | One handbook's chapters with article ids. | All | read:handbooks |
list_courses | Catalogue of courses. include_drafts, include_chapters. | All | read:courses |
get_course | One course's chapters with article and quiz ids. | All | read:courses |
get_article | Full text of a chapter, announcement or event as markdown. locale. | All | read:articles |
search_content | Full-text search across handbooks, courses, announcements and events. query, handbook_id, in, include_past, limit. Reports match_quality. | All | read:articles |
create_handbook | New handbook as a draft. title, groups, locale. | Editors | write:handbooks |
create_course | New course as a draft. title, groups, locale. | Editors | write:courses |
add_chapter | Add a chapter of headers, paragraphs and image galleries to a handbook or course. Live if the container is published unless is_published: false. | Editors | write:handbooks or write:courses |
add_quiz | Attach a multiple-choice quiz (1 to 30 questions) to a course chapter. Live on published courses. | Editors | write:courses |
compose_article | Append content blocks to any article. Live on published content unless is_published: false. | Editors | write:articles |
People
| Tool | What it does | Access | Scope |
|---|---|---|---|
search_users | Find employees by name or email, with groups and registration status. query, group_id, limit. | All | read:users |
get_user | One employee's profile: groups, roles, hire date, last activity, sync origin. | All | read:users |
list_groups | Departments, professions and custom groups with managers and member counts. type, limit (default 50, max 100), include_mappings. | All | read:groups |
preview_audience | Who would see content with a given targeting, or an item's current audience. | All | read:groups |
get_org_chart | The 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_departments | Departments from connected HR or scheduling systems and whether they are mapped. | Admins | read:groups |
list_external_groups | Professions from connected HR or scheduling systems and whether they are mapped. | Admins | read:groups |
create_group | Create a department, profession or custom group. Live immediately. name, type, is_open. | Admins | write:groups |
Communication
| Tool | What it does | Access | Scope |
|---|---|---|---|
list_walls | Social walls the connected identity can see, with post counts. | All | read:walls |
list_posts | Recent published posts. wall_id, days (default 30), limit. | All | read:posts |
list_events | Upcoming company events and calendar entries. from, to, limit. | All | read:events (read:calendar_entries for calendar rows) |
create_post | Wall post as a draft. body, wall_id. | All, where the person may post | write:posts |
create_announcement | Announcement as a draft. title, body, subtitle, groups, locale. | All | write:announcements |
create_event | Company event as a draft. title, body, starts_at, starts_time, ends_at, location, groups, locale. | All | write:events |
Training
| Tool | What it does | Access | Scope |
|---|---|---|---|
get_journey | A journey's items in order, including journey-list tasks. | Editors | read:courses |
create_journey | Journey as a draft from existing courses, handbooks and forms. title, items, groups, days_after_hire, body, locale. | Editors | write:courses |
assign_course | Enrol people or groups on a course. Dry run until confirm: true. | All | write:courses |
assign_journey | Roll a journey out to more groups. Dry run until confirm: true. | Editors | write:courses |
list_expiring_certificates | Expired and soon-expiring certificates per employee. days (default 90), group_ids, limit (max 50). | Admins + managers | read:certificates |
get_user_progress | One employee's onboarding, journeys, courses and certificates. | Admins + managers | read:stats |
Forms and checklists
| Tool | What it does | Access | Scope |
|---|---|---|---|
list_forms | Catalogue 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 owners | read:forms |
get_form | A form's fields, choices, targeting and response count. Whistleblower forms excluded. | Editors | read:forms |
get_form_responses | Recent 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 recipients | read:formresponses |
get_form_alarms | Answers 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 recipients | read:formresponses |
list_todo_lists | To-do list templates with task counts and groups. include_drafts. | All | read:todolists |
get_todo_list | A template's tasks. | All | read:todolists |
get_todo_compliance | Checklist completion per department, worst first. days (default 7), group_ids. Needs the to-do feature. | Admins + managers | read:stats |
Insights
| Tool | What it does | Access | Scope |
|---|---|---|---|
get_academy_stats | Onboarding, course and journey completion. area, group_ids, per_department. | Admins + managers | read:stats |
get_academy_overview | The Academy dashboard figures, per department and per user. group_ids, per_department, include_users, sort, onboarding_status, limit. | All | read:stats |
get_engagement_stats | App usage over time, adoption per department, user and content summaries. area, granularity, scope, group_ids. | Admins + global editors; managers get engagement and adoption | read:stats |
get_content_reach | Most or least viewed handbooks or posts. kind, months, direction, limit. | Admins + global editors | read:stats |
audit_content | Published handbooks ranked by how long since they were edited. limit (max 50). | Admins + global editors | read:stats |
manager_hub_summary | The Manager Hub department report. department_ids. Needs the Manager Hub feature. | Admins + managers | read:managerhub |
get_survey_results | Aggregated survey results per question, never with names. survey_id (omit to list surveys). | Admins + managers | read:surveys |
Media
| Tool | What it does | Access | Scope |
|---|---|---|---|
upload_media | Store an image (base64, about 5 MB max) and get a media_id for image galleries. Only the same identity can attach it later. | All | write:media |
Open API fallback
| Tool | What it does | Access | Scope |
|---|---|---|---|
call_open_api | Raw request to any Open API endpoint when no dedicated tool fits. method, path, query, body. Responses are cut at 40 kB. | Admins, signed in only | Never offered to tokens |
Resources
Resources are read-only documents an assistant can load for context.
| Resource | Contents | Scope for tokens |
|---|---|---|
monotree://locales | Active content languages and the default. The valid values for every locale argument. | none |
monotree://org-structure | Departments, 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_chapterandcompose_article:{"type":"header","text"},{"type":"paragraph","markdown"},{"type":"image_gallery","media_ids":[]}. Up to 100 blocks; the call is atomic. localemust be an active language. New content gets your default content language when omitted.- Every content result carries a
cms_url.