Tool reference
The Klarify MCP server exposes tools across session management, content search, organizational structure, and content management. Tools are registered per session based on the signed-in user’s role — you only see tools your role allows. See how Klarify AI applies your permissions for the access matrix.
The examples in this page show natural-language prompts you can give an AI client. The AI translates each prompt into the appropriate tool call.
Guided prompts
Alongside individual tools, the Klarify MCP server offers prompts — reusable, guided workflows an AI client can start on request. Where a tool performs a single action, a prompt runs a whole walkthrough, calling the tools it needs and adapting to your role. MCP-compatible clients surface prompts as selectable starting points; how they appear depends on the client.
| Prompt | Role | Description |
|---|---|---|
onboard_employee | All | A guided, interactive introduction to Klarify that walks you through your account, employee record, position(s), accountabilities and responsibilities, the document repository, and your organization’s structure — one area at a time |
The onboarding walkthrough adapts to who you are. An employee is guided through all six areas; a guest, who has read-only access, is shown only the account overview and the document folder structure, with the other areas explained as unavailable. Members with an admin role are additionally offered the broader organization structure — departments, positions, regions, and locations.
By default the walkthrough covers every area in order. To focus on just one, the prompt accepts an optional step argument: welcome, profile, positions, responsibilities, documents, or people.
Examples
Onboard me to Klarify.
Walk me through just my accountabilities and responsibilities.
Session
These tools are available to every signed-in user.
| Tool | Role | Description |
|---|---|---|
get_current_user | All | Returns the signed-in user’s name, email, employee ID, role, and current organization |
list_capabilities | All | Lists everything the AI can help you do, grouped by area and filtered to the actions your role permits. Ask about a specific area to drill into its individual actions, with read/write and destructive markers |
Examples
Who am I signed in as in Klarify?
What can you do?
What can you help me with for employees?
Search and discovery
| Tool | Role | Description |
|---|---|---|
search_documents | Employee+ | Semantic search across process models, global tasks, and other documents |
search_glossary | Employee+ | Search the organization’s terms glossary and return matching term/definition pairs, including alternate terms |
Examples
Find any process related to customer onboarding.
Search Klarify for documents that mention SOC 2.
What does PO mean in our organization?
Process models and global tasks
| Tool | Role | Description |
|---|---|---|
list_procedures | Employee+ | List process models and global tasks with filters for type, status, folder, or owner |
get_procedure | Employee+ | Get a document’s details, variants, and associated process data |
get_procedure_variant | Employee+ | Get a specific document variant including sections and task instructions |
get_process | Employee+ | Get a process model record including its BPMN flowchart XML |
list_process_activities | Employee+ | List the activities (tasks) within a process model |
list_activities_by_performer | Employee+ | List activities where a specific user is the task performer |
describe_process | Employee+ | Generate a plain-language description of a process model |
list_user_documents | Employee+ | List documents where a specific user is the assigned owner (accountable) or a task performer (responsible) — not based on edit access. Call twice: once with role=owner and once with role=performer |
find_documents | Employee+ | Find documents by name, returning the owner position and resolved performers. Matches drafts that semantic search does not, so it’s useful for locating a specific document |
get_recent_procedures | Employee+ | List the most recently updated process models and global tasks |
Examples
Show me all published process models in the Finance folder.
Describe the Customer Onboarding process model in plain language.
Which activities in the Quarterly Close process model are assigned to Maya?
List every document Priya Patel owns or is a performer on.
Document visibility
These tools change who can see a process model or global task — setting it to Private, Organization, or Public. They are available to members with Editor or Manager content access and apply only to documents you can edit; Viewers and guests do not see them.
| Tool | Role | Description |
|---|---|---|
set_procedure_visibility | Editor+ | Set one process model or global task — by name or ID — to PRIVATE, ORGANIZATION, or PUBLIC |
bulk_update_procedure_visibility | Editor+ | Set the visibility of many documents at once, either from a list of names and IDs or for every document in a folder (including its subfolders) |
Like other changes, a visibility change is previewed for your approval before it is applied, and a change that would set a document to the value it already has is skipped as a no-op. Each document in a bulk change is reported individually as succeeded, skipped, or failed — nothing fails silently. If a name matches more than one document, the assistant lists the candidates so you can re-run with the exact one. First drafts are always private and stay private until the document is published.
Examples
Make the Customer Onboarding process model organization-wide.
Set every document in the Public Handbook folder to Public.
Make the Vendor Approval Checklist private.
Folders and document hierarchy
| Tool | Role | Description |
|---|---|---|
list_folders | Employee+ | List the folder hierarchy |
create_folder | Admin | Create a new folder in the document hierarchy |
rename_folder | Admin | Rename a folder |
delete_folder | Admin | Delete a folder |
move_entity | Admin | Move a folder, process model, or global task to a new parent |
add_procedure_to_folder | Admin | Add or move a process model or global task into a folder |
remove_procedure_from_folder | Admin | Remove a process model or global task from its folder |
Examples
Show me the folder structure under Operations.
Create a folder called 2026 Audits under Compliance.
Move the Vendor Approval Checklist global task into the Procurement folder.
Organization
| Tool | Role | Description |
|---|---|---|
get_organization | All | Core organization info: ID, name, domain, type, picture |
get_organization_stats | Employee+ | Counts of employees, departments, and regions |
get_organization_settings | Admin | SSO and login settings |
get_organization_billing | Account Owner | Billing details: plan, period, next bill |
list_organization_members | Employee+ | List members with their admin role and content access; supports search, role, access-level, and active-only filters with pagination |
Examples
How many employees and departments does my organization have?
What SSO provider is configured on this organization?
List the Org Admins on this organization.
Snapshots and summaries
These tools return quick, aggregated overviews of the organization, useful for getting your bearings before drilling into specific records.
| Tool | Role | Description |
|---|---|---|
get_org_summary | Employee+ | Get a concise snapshot of the current organization |
get_teams_with_counts | Employee+ | List teams with their member positions and admins, plus the total team count |
get_departments_with_counts | Employee+ | List departments with the total department count |
get_folder_tree | Employee+ | Get the top-level folders and their immediate children |
Examples
Give me a quick summary of this organization.
How many teams and departments do we have?
Members and invitations
These tools manage who belongs to the organization — inviting people, changing their access, and deactivating or removing members. Most write actions return a preview for approval before they take effect, and destructive changes that would orphan document responsibilities ask you to choose a transfer target first.
| Tool | Role | Description |
|---|---|---|
get_member | Employee+ | Get a member’s full details, including linked employee, status, and access levels |
list_invited | Employee+ | List pending and expired invitations, with filters for search, member type, and status |
list_member_audit_events | Admin | List the member-management audit trail (invites, access and role changes, deactivations, removals), newest first |
invite_employee_member | Admin | Invite one or more people as employee members, who can hold positions and count toward billing |
invite_guest_member | Admin | Invite one or more people as guest members, with read-only access and no billing impact |
resend_member_invitation | Admin | Resend a pending or expired invitation, resetting its expiry |
cancel_member_invitation | Admin | Cancel a pending or expired invitation |
update_member_content_access | Admin | Change a member’s content access level; downgrading to read-only asks for a transfer target so edit responsibilities are not orphaned |
update_member_admin_role | Admin | Change a member’s admin role |
deactivate_member | Admin | Deactivate a member and revoke their access, asking how to transfer their documents; the employee record is preserved for reactivation |
reactivate_member | Admin | Reactivate a previously deactivated member, restoring their role and access |
remove_member | Admin | Permanently remove a member. The member must be deactivated first, and the action cannot be undone |
Examples
Invite sam@acme.com as an employee with edit access.
List everyone with a pending invitation.
Deactivate Sam Lee and transfer their documents to Priya Patel.
Employees
| Tool | Role | Description |
|---|---|---|
list_employees | Employee+ | List employees with optional search and department filters |
get_employee | Employee+ | Get an employee’s full details, positions, and linked user info |
create_employee | Admin | Create an employee (requires first name, last name, email) |
update_employee | Admin | Update an employee’s fields by ID |
delete_employee | Admin | Delete an employee, with optional data transfer |
bulk_create_employees | Admin | Bulk-create employees from a CSV string |
Examples
List all employees in the Marketing department.
Show me the full record for Priya Patel.
Create a new employee: Sam Lee, sam@acme.com.
For CSV format details, see CSV bulk import.
Positions
| Tool | Role | Description |
|---|---|---|
list_positions | Employee+ | List positions with filters for job title, department, or region |
get_position | Employee+ | Get a position’s details: employee, department, region, manager, teams |
create_position | Admin | Create a new position (requires job title and region) |
update_position | Admin | Update position fields by ID |
delete_position | Admin | Delete a position |
bulk_create_positions | Admin | Bulk-create positions from CSV |
assign_employee_to_position | Admin | Assign an employee to a position |
unassign_employee_from_position | Admin | Remove an employee from a position |
update_employee_position | Admin | Update an employee’s position assignment |
bulk_assign_employees_to_positions | Admin | Bulk-assign employees to positions from CSV |
add_position_roles | Admin | Add one or more role labels to a position |
remove_position_roles | Admin | Remove one or more role labels from a position |
Examples
List every open position in the London region.
Assign Priya Patel to the Senior Analyst position.
Departments
| Tool | Role | Description |
|---|---|---|
list_departments | Employee+ | List departments |
get_department | Employee+ | Get a department’s positions and employees |
create_department | Admin | Create a new department |
update_department | Admin | Update a department by ID |
delete_department | Admin | Delete a department by ID |
bulk_create_departments | Admin | Bulk-create departments from CSV |
Examples
List all departments and how many employees each has.
Create a new department called Customer Success reporting to Operations.
Teams
| Tool | Role | Description |
|---|---|---|
list_teams | Employee+ | List teams with members |
get_team | Employee+ | Get a team’s details, members, and admins |
create_team | Admin | Create a new team |
update_team | Admin | Update a team by ID |
delete_team | Admin | Delete a team by ID |
bulk_create_teams | Admin | Bulk-create teams from CSV |
add_team_member | Admin | Add a position to a team |
remove_team_member | Admin | Remove a position from a team |
bulk_add_team_members | Admin | Bulk-add positions to teams from CSV |
Examples
List the members of the Incident Response team.
Add the Senior Analyst position to the Risk Review team.
Regions
| Tool | Role | Description |
|---|---|---|
list_regions | Employee+ | List every region in the organization |
create_region | Admin | Create a new named region |
update_region | Admin | Update a region’s name |
delete_region | Admin | Delete a named region (the GLOBAL region is protected) |
bulk_create_regions | Admin | Bulk-create regions from CSV |
Examples
List all Klarify regions.
Create a new region called APAC.
Locations
| Tool | Role | Description |
|---|---|---|
list_locations | Employee+ | List locations with optional search and region filters |
get_location | Employee+ | Get a location’s region and country |
create_location | Admin | Create a new location |
update_location | Admin | Update a location by ID |
delete_location | Admin | Delete a location by ID |
list_countries | Employee+ | List countries, used to resolve a country name to the ID needed when creating locations or employees |
list_states | Employee+ | List states or provinces, optionally filtered by country, used to resolve a state name to its ID |
Examples
List every location in the APAC region.
Create a new location in the Singapore region.
Klarify Partners
These tools are only relevant to Klarify Partner organizations — partners managing one or more client organizations from a single partner account. Sign in to your partner org first, then use these tools to list the partner’s clients, switch into a client org, and manage which partner employees are assigned where.
| Tool | Role | Description |
|---|---|---|
list_my_organizations | All | List every organization the signed-in user has access to, labelled [partner] / [client] and showing which org is currently active |
switch_organization | All | Verify access to another organization and return the steps to reconnect to it. The tool cannot change the active organization itself because the organization is selected during sign-in |
list_partner_clients | Admin | List the client organizations managed by the current partner org, including which partner employees are assigned to each client |
add_partner_user_to_client | Admin | Add a partner employee to a client organization, using the client’s default role and access |
remove_partner_user_from_client | Admin | Remove a partner employee from a client organization |
Examples
What organizations do I have access to in Klarify?
Switch me to the Acme Corp organization.
Show me every client organization our partner org manages.
Add Priya Patel as a partner employee on the Acme Corp client.
Remove Sam Lee from the Beta Industries client.
CSV bulk import
The bulk import tools accept a CSV string containing a header row followed by data rows. The tool returns a result object indicating how many rows were created, how many failed, and the errors per failed row.
| Tool | Required columns | Optional columns |
|---|---|---|
bulk_create_employees | first_name, last_name, email | middle_name, display_name, telephone, address, unit_no, city, state_id, zip_code, country_id, timezone, department (by name; created if it does not exist), position_id, team_id |
bulk_create_positions | job_title, region_id (accepts a region name or ID) | department_id, location_id, work_status, work_schedule, work_mode, manager_position_id, job_overview, position_roles (comma-separated) |
bulk_create_regions | name | — |
bulk_create_teams | name | overview |
bulk_create_departments | name | parent_department_id, parent_department_name (or parent_department, by name), tag_color |
bulk_assign_employees_to_positions | employee_id, position_id | type (defaults to PRIMARY) |
bulk_add_team_members | team_id, position_id | — |
Example
Import these employees from CSV: …
Role abbreviations used above
| Label | Meaning |
|---|---|
| All | Every signed-in user, including Guest |
| Employee+ | Any Klarify member (Employee, Guest excluded), plus all admin roles |
| Editor+ | Any member with Editor or Manager content access (Viewers and guests excluded), applied per document you can edit |
| Admin | Org Admin, Super Admin, Account Manager, or Account Owner |
| Account Owner | Account Owner only |
See how Klarify AI applies your permissions for the full matrix.