Workshop Tools
These tools are only advertised when the supplier has the Rentals module enabled. See Per-supplier tool filtering.
View items currently in the workshop for maintenance or repair, get job details, look up barcodes, manage checklists, and assign staff.
Required scope: products:read for read operations, products:write for mutations.
Tools Overview
| Tool | Description | Read-only? |
|---|---|---|
get_workshop_items | List items currently in the workshop | Yes |
get_workshop_detail | Get full details of a workshop item | Yes |
lookup_barcode | Look up what a barcode belongs to | Yes |
get_checklist_templates | List available checklist templates | Yes |
get_checklist_template_detail | Get a template with its items | Yes |
get_workshop_checklists | List checklists on a workshop job | Yes |
complete_checklist_item | Mark a checklist item as complete | No |
uncomplete_checklist_item | Reset a checklist item to incomplete | No |
attach_checklist_to_workshop | Attach a checklist template to a job | No |
remove_checklist_from_workshop | Remove a checklist from a job | No |
create_checklist_template | Create a custom checklist template | No |
assign_staff_to_workshop | Assign staff to a workshop job | No |
unassign_staff_from_workshop | Remove staff from a workshop job | No |
get_workshop_items
List items currently in the workshop (maintenance, repair, etc.). Response includes checklist progress and assigned staff for each item.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter by status: inWorkshop, scheduled, overdue, completed. Default: in workshop + scheduled. |
search | string | No | Search by product name or inventory identifier |
Response Fields
Each item includes: workshop_log_id, product_name, inventory_identifier, status, reason, checked_in_at, scheduled_start, scheduled_end, checklist_progress (e.g. "3/5"), has_critical_failures, assigned_staff (array of names).
get_workshop_detail
Get full details of a specific workshop item by workshop log ID. Includes job details, timeline, overdue status, notes, checklists with full item details, and assigned staff.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
workshop_log_id | integer | Yes | The workshop log ID |
Response Fields
Includes all fields from get_workshop_items plus: variation, quantity, date_added, expected_completion, date_removed, duration_in_workshop, overdue, auto_complete, notes, checklists (array with full item details), assigned_staff (array with user_id, name, email).
lookup_barcode
Look up what a barcode belongs to (product or inventory item).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
barcode_value | string | Yes | The barcode value to look up |
get_checklist_templates
List available checklist templates for workshop inspections and maintenance procedures. Returns both prebuilt (system) and custom (supplier-created) templates.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
search | string | No | Search templates by name |
category | string | No | Filter by equipment category |
type | string | No | Filter by type: prebuilt or custom |
get_checklist_template_detail
Get full details of a checklist template including all its items with types and criticality.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
template_id | integer | Yes | The checklist template ID |
get_workshop_checklists
List all checklists attached to a workshop job, including item completion progress, status, and critical failure detection.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
workshop_log_id | integer | Yes | The workshop log ID |
complete_checklist_item
Mark a checklist item as complete, optionally providing a value and notes.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
item_id | integer | Yes | The checklist item ID to complete |
value | string | No | Value for the item. For checkbox: "1". For pass/fail: "pass" or "fail". For text/numeric: the value. |
notes | string | No | Additional notes for this checklist item |
Item Type Values
| Type | Expected Value |
|---|---|
checkbox | Auto-set to "1", no value needed |
pass_fail | "pass" or "fail" |
text | Free-form text |
numeric | Numeric string |
photo | Optional caption (photo upload not available via MCP) |
uncomplete_checklist_item
Reset a completed checklist item back to incomplete. Clears the value, notes, and completion timestamp.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
item_id | integer | Yes | The checklist item ID to reset |
attach_checklist_to_workshop
Attach a checklist template to a workshop job. Creates a new checklist instance with all items from the template. A template can only be attached once per job.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
workshop_log_id | integer | Yes | The workshop log ID to attach the checklist to |
template_id | integer | Yes | The checklist template ID to attach |
remove_checklist_from_workshop
Remove a checklist from a workshop job. Also deletes any uploaded photos for the checklist items.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
workshop_log_id | integer | Yes | The workshop log ID |
checklist_id | integer | Yes | The checklist ID to remove |
create_checklist_template
Create a custom checklist template with items for workshop inspections and maintenance. The template will be available to the supplier for attaching to future workshop jobs.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Template name |
description | string | No | Description of the template |
equipment_category | string | No | Equipment category (e.g. "Bikes", "Kayaks") |
items | array | Yes | Array of checklist items (see below) |
Item Object
| Name | Type | Required | Description |
|---|---|---|---|
label | string | Yes | Item label/question |
description | string | No | Detailed description |
type | string | No | Item type: checkbox (default), pass_fail, text, numeric, photo |
is_critical | boolean | No | Whether failure of this item flags a critical issue |
assign_staff_to_workshop
Assign one or more staff members to a workshop job. Staff must belong to the same supplier. Already-assigned staff members are skipped without error.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
workshop_log_id | integer | Yes | The workshop log ID |
staff_ids | array of integers | One list required | Staff IDs to assign, including staff without logins |
user_ids | array of integers | One list required | Legacy login user IDs to assign |
Provide exactly one of staff_ids or user_ids. Every selected person must belong to this shop; a foreign ID rejects the whole selection.
unassign_staff_from_workshop
Remove a staff member from a workshop job.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
workshop_log_id | integer | Yes | The workshop log ID |
staff_id | integer | One ID required | Staff ID to remove, including staff without logins |
user_id | integer | One ID required | Legacy login user ID to remove |
Provide exactly one of staff_id or user_id. A staff record and its linked login count as one person; removing either removes both assignments on the job.
update_workshop_job
Edit an open job's reason or due date. Completed jobs cannot be edited. The caller needs workshop permission in the same shop, or an API key with products:write.
| Name | Type | Required | Description |
|---|---|---|---|
workshop_log_id | integer | Yes | The workshop job ID |
reason | string or null | No | maintenance, repair, cleaning, other, or returned_damaged; null clears it |
due_date | string or null | No | Due date in the shop's own time: YYYY-MM-DD (due by the end of that day) or YYYY-MM-DD HH:MM; null clears it |
Omit a field to keep its saved value. A due date must follow a scheduled start.
Related
- Workshop REST API - REST API endpoints for workshop
- Checklist Templates REST API - Checklist template endpoints
- Workshop Checklists REST API - Workshop checklist endpoints
- Products Tools - Product and inventory management