Tools Reference

Everything the Raken connector can do, grouped into read tools (safe, non-mutating) and write tools (create / update). This page is generated from the running server, so it always matches the deployed tools.

Read tools

Tool What it does
get_user_info Show the Raken user profile for the connected account — first name, last name, email, user UUID (sub), role, and company UUID. Handy as a quick check that the connector is working.
list_projects List the projects on your Raken account. Filter by status or by when they were last changed. When resolving a project name to its UUID, prefer query over paging the full collection — page size is capped at 100, so a targeted search is faster and cheaper. Results are paginated; use limit and offset to page through them.
get_project Get full details for a single project by UUID. Useful for resolving a projectUuid referenced elsewhere (e.g. on a time card or work log) to its full project details.
list_project_employees List the employees assigned to a project. Filter by status, classification (trade / craft), or role. Results are paginated; use limit and offset to page through them.
list_employees List the employees on your Raken account. Filter by status, project, classification, role, or when they were last changed. Employees include both workers (labor tracked on time cards, no login) and users (with logins). When resolving a name to its UUID, prefer query over paging the full collection — page size is capped at 100, so a targeted search is faster and cheaper. query also matches employee ID, email, and phone number. Results are paginated; use limit and offset to page through them.
get_employee Get full details for a single employee by UUID. Useful for resolving a workerUuid returned by list_time_cards (e.g. on a time card) to the employee's full details.
list_employee_projects List the projects a specific employee is assigned to on your Raken account. Filter by project status. Returns a reduced set of fields per project compared to the full project list. Results are paginated; use limit and offset to page through them.
list_classifications List the worker classifications (trade / craft labels) on your Raken account. Results are paginated; use limit and offset to page through them.
list_cost_codes List the cost codes on your Raken account. Optionally limit to a single project, or filter by when they were last changed. Results are paginated; use limit and offset to page through them.
list_pay_types List the pay types (regular, overtime, double-time, etc.) configured on your Raken account. Results are paginated; use limit and offset to page through them.
list_shifts List the shifts (day, swing, night, etc.) configured on your Raken account. Results are paginated; use limit and offset to page through them.
list_work_logs List the work log (manpower) entries on your Raken account. Filter by project and date range. Each entry records crew headcount and hours by trade for a project on a given day. Results are paginated; use limit and offset to page through them.
list_time_cards List the time card entries on your Raken account. Filter by time card date range or updated date range. Optionally filter to deleted time cards only with a deleted date range. Each entry records a worker's hours on a project along with its classification, pay type, and shift. Results are paginated; use limit and offset to page through them.
list_checklist_templates List the checklist templates on your Raken account. Filter by checklist type or status. Every checklist is created from a template and inherits it, so a template UUID can be used to filter the checklist tool. Results are paginated; use limit and offset to page through them.
list_checklist_types List the checklist types configured on your Raken account. Filter by class or status. Checklist type is an attribute of both checklist templates and checklists, so results can be used to filter the checklist template and checklist tools. Results are paginated; use limit and offset to page through them.
list_checklists List the checklists on your Raken account in any status. Returns high-level details only, not the full checklist contents. Filter by project, status, creating employee, template, checklist type, creation date range, or checklist date range. Use this for completion-rate stats, checking whether specific checklists are done, or reporting and distribution automation. To read the answers on a checklist, call get_checklist_details per result. Results are paginated; use limit and offset to page through them.
get_checklist_details Retrieve the full detail for a single checklist by UUID, including sections, questions, question types, responses, response attachments, related observations, and checklist location. Returns one checklist per call.
list_observations List the observations on your Raken account. Filter by project, status, category, priority, creation date range, or last-updated date range. Useful for reporting, dashboards, and automation triggered by new observations. Results are paginated; use limit and offset to page through them.
get_observation_details Retrieve the full detail for a single observation by UUID, including assignees, corrective actions, attachments, category, type, priority, status, and location. Can be called as a follow-on to get details of observations referenced by other resources, such as checklists. Returns one observation per call.

Write tools

Every write is confirmation-gated. The first call never changes anything — it returns a preview of the exact request and waits for your explicit approval before committing. Updates use Raken's PATCH semantics, which replace array fields (e.g. a project's member list) rather than merging them.

Tool What it does
create_project Create a single project on your Raken account. Requires a project name and start date; optional fields include number, address, end date, status, email recipients, and external ID. Email recipients may be internal to your company or external. Creates one project per call after user confirmation.
update_project Update a single project on your Raken account. All fields are optional; supply only the fields to change (name, number, address, start or end date, status, email recipients, external ID). Email recipients may be internal to your company or external. Setting a project to inactive or deleted is a status change only, not a hard delete. Applies the change to one project per call after user confirmation.
create_worker_employee Create a single worker (ROLE_WORKER) on your Raken account. This tool creates workers only; the role is fixed and cannot be selected. Email is optional for workers. Optionally assign the worker to projects and set default time settings. Creates one worker per call after user confirmation.
update_employee Update a single employee on your Raken account. All fields are optional; supply only what changes (name, project assignments, contact details, classification, time settings, or status). An employee's role cannot be changed through this tool. Email cannot be updated for employees who can log in (any role other than ROLE_WORKER). Applies the change to one employee per call after user confirmation.
update_project_assignments Change project assignments for employees on your Raken account in one batch call. Append, replace, or remove up to 100 employees across up to 10 projects specified by project UUID. Applies the change after user confirmation.