UpKeep MCP by usefulapi
Read UpKeep work orders, assets, parts and meters; create requests and work orders.
Should I use this
Quality & Safety
A
Findings (1)
- LOWTool 'upkeep_list_preventive_maintenance' name length outside 3-30 rangein upkeep_list_preventive_maintenance
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
~8,462Tokens (tool definitions)
~2.5 KBTypical response size
Significant attention impact (6.61% of 128k context)
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"upkeep": {
"url": "https://upkeep.usefulapi.io/mcp"
}
}
}Remote endpoints
https://upkeep.usefulapi.io/mcpstreamable-httpWhat it can do
Tool inventory
Tools (29)
🟢 Read-only🟡 Write🔴 Delete⚪ Unknown
🟢upkeep_get_account
Confirm the UpKeep API token is active: returns the company id, the token's name, when it was created and when it was last used. GET /api/v1/organization-api-tokens/introspect.
Input Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_work_orders(status, is_complete, archived, priority, category, ...)
List work orders (reactive and preventive), newest first, with status, priority, due date, asset, location, assignee, parts, time and cost. Filter by status, completion, priority, category, asset, location, assignee, title or date ranges. GET /work-orders.
Input Schema
{
"type": "object",
"properties": {
"status": {
"description": "Only work orders in this status.",
"type": "string",
"enum": [
"open",
"onHold",
"inProgress",
"complete"
]
},
"is_complete": {
"description": "true = only completed work orders, false = only not yet completed.",
"type": "boolean"
},
"archived": {
"description": "true = only archived work orders.",
"type": "boolean"
},
"priority": {
"type": "integer",
"minimum": 0,
"maximum": 3,
"description": "Priority: 0 none/lowest, 1 low, 2 medium, 3 high."
},
"category": {
"description": "Only this work order category (e.g. Electrical).",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"title": {
"description": "Only work orders with exactly this title.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"asset": {
"description": "Only records for this asset id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"location": {
"description": "Only records for this location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assigned_to_user": {
"description": "Only records for this assigned user id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assigned_by_user": {
"description": "Only records for this assigning user id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"public_requester_email": {
"description": "Only work orders created by this email through the request portal.",
"type": "string",
"minLength": 1,
"maxLength": 254
},
"due_after": {
"description": "Due at or after this time. ISO 8601.",
"type": "string"
},
"due_before": {
"description": "Due at or before this time. ISO 8601.",
"type": "string"
},
"completed_after": {
"description": "Completed at or after this time. ISO 8601.",
"type": "string"
},
"completed_before": {
"description": "Completed at or before this time. ISO 8601.",
"type": "string"
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt, dueDate, endDueDate, dateCompleted (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: asset, location, assignedToUser, assignedByUser, requestedByUser, completedByUser, team.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_get_work_order(work_order_id, includes)
One work order by id with its checklist items, custom fields, time log, parts and files. GET /work-orders/{id}.
Input Schema
{
"type": "object",
"properties": {
"work_order_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep work order id (a short string such as \"HW2I379ErS\")."
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: asset, location, assignedToUser, assignedByUser, requestedByUser, completedByUser, team.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
}
},
"required": [
"work_order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_assets(name, serial_number, barcode, location, status, ...)
List assets (equipment) with name, model, serial and barcode, location, status, downtime status, warranty and number of open work orders. Filter by name, serial number, barcode, location, status, category or assignee. GET /assets.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only assets with exactly this name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"serial_number": {
"description": "Only the asset with this serial number.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"barcode": {
"description": "Only the asset with this barcode number.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"location": {
"description": "Only records for this location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"status": {
"description": "Only assets with this status (active or inactive).",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"category": {
"description": "Only assets in this category.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assigned_to_user": {
"description": "Only records for this assigned user id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"downtime_status": {
"description": "Only assets with this downtime status id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: location, parentAsset, createdByUser, assignedToUser.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_get_asset(asset_id, includes)
One asset by id with purchase and warranty details, custom fields and (optionally) assigned users, teams, vendors, parts, files and sub-assets. GET /assets/{id}.
Input Schema
{
"type": "object",
"properties": {
"asset_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep asset id (a short string such as \"HW2I379ErS\")."
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: assignedUsers, assignedTeams, assignedCustomers, assignedVendors, formItems, files, parts, subAssets, location, parentAsset, createdByUser, assignedToUser.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
}
},
"required": [
"asset_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_locations(name, barcode, parent_location, hierarchy_level, created_after, ...)
List locations (sites, buildings, rooms) with address, barcode, parent location and hierarchy level. GET /locations.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only locations with exactly this name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"barcode": {
"description": "Only the location with this barcode.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"parent_location": {
"description": "Only records for this parent location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"hierarchy_level": {
"description": "Only this hierarchy level (0 = top level, up to 5).",
"type": "integer",
"minimum": 0,
"maximum": 5
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: createdByUser, parentLocation, hierarchyLevel, ancestors, numTotalChildren, numTotalDescendants.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_get_location(location_id)
One location by id. GET /locations/{id}.
Input Schema
{
"type": "object",
"properties": {
"location_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep location id (a short string such as \"HW2I379ErS\")."
}
},
"required": [
"location_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_parts(name, category, location, part_number, created_after, ...)
List spare parts with quantity on hand, minimum quantity, cost, category, location and part number. Compare quantity with minimumQuantity to find parts to reorder. GET /parts.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only parts with exactly this name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"category": {
"description": "Only parts in this category.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"location": {
"description": "Only records for this location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"part_number": {
"description": "Only parts with this part number.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: location, createdByUser.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_get_part(part_id)
One part by id with quantity, cost, location and custom fields. GET /parts/{id}.
Input Schema
{
"type": "object",
"properties": {
"part_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep part id (a short string such as \"HW2I379ErS\")."
}
},
"required": [
"part_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_meters(name, asset, location, created_after, created_before, ...)
List meters (usage counters such as hours, mileage, temperature) with units, reading frequency and the asset or location they belong to. GET /meters.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only meters with exactly this name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"asset": {
"description": "Only records for this asset id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"location": {
"description": "Only records for this location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: asset, location, createdByUser.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_get_meter(meter_id)
One meter by id. GET /meters/{id}.
Input Schema
{
"type": "object",
"properties": {
"meter_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep meter id (a short string such as \"HW2I379ErS\")."
}
},
"required": [
"meter_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_meter_readings(meter_id, read_after, read_before, order_by, offset, ...)
Readings recorded for one meter (value, date, who recorded it), newest first. GET /meters/{id}/readings.
Input Schema
{
"type": "object",
"properties": {
"meter_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep meter id (a short string such as \"HW2I379ErS\")."
},
"read_after": {
"description": "Reading date at or after this time. ISO 8601.",
"type": "string"
},
"read_before": {
"description": "Reading date at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"required": [
"meter_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴upkeep_add_meter_reading(meter_id, value, date)
WRITE: record a new reading on a meter (for example engine hours or mileage). A reading cannot be removed with this server, and a meter notification can create a work order automatically when its condition is met. POST /meters/{id}/readings.
Input Schema
{
"type": "object",
"properties": {
"meter_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep meter id (a short string such as \"HW2I379ErS\")."
},
"value": {
"type": "number",
"description": "The reading value."
},
"date": {
"description": "When the reading was taken (ISO 8601). Defaults to now.",
"type": "string"
}
},
"required": [
"meter_id",
"value"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_requests(request_status, location, asset, team, assigned_to_user, ...)
List work requests submitted by staff or through the request portal (before they become work orders), with status open/approved/rejected. GET /requests.
Input Schema
{
"type": "object",
"properties": {
"request_status": {
"description": "Only requests in this state.",
"type": "string",
"enum": [
"requested",
"declined",
"approved"
]
},
"location": {
"description": "Only records for this location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"asset": {
"description": "Only records for this asset id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"team": {
"description": "Only records for this team id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assigned_to_user": {
"description": "Only records for this assigned user id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"requested_by_user": {
"description": "Only records for this requesting user id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"category": {
"description": "Only this request category.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"public_requester_email": {
"description": "Only requests sent by this email through the request portal.",
"type": "string",
"minLength": 1,
"maxLength": 254
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt, dueDate, endDueDate (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: asset, location, team, assignedToUser, assignedByUser, cancelledByUser.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_get_request(request_id)
One work request by id with its form fields and, once approved, the linked work order id. GET /requests/{id}.
Input Schema
{
"type": "object",
"properties": {
"request_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep request id (a short string such as \"HW2I379ErS\")."
}
},
"required": [
"request_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴upkeep_create_request(title, description, priority, location, asset, ...)
WRITE: submit a new work request for the maintenance team to approve (it appears in UpKeep's Requests list and may notify the approvers or the assignee). It is not a work order until approved. If the account has a request form configured, pass its field labels in `fields`. POST /requests.
Input Schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 250,
"description": "Short title, e.g. Repair sink."
},
"description": {
"type": "string",
"maxLength": 5000
},
"priority": {
"type": "integer",
"minimum": 0,
"maximum": 3,
"description": "Priority: 0 none/lowest, 1 low, 2 medium, 3 high."
},
"location": {
"description": "Location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"asset": {
"description": "Asset id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"team": {
"description": "Team id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assigned_to_user": {
"description": "User id to assign.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"due_date": {
"description": "Due date, ISO 8601.",
"type": "string"
},
"category": {
"description": "Must be one of the account's configured categories.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"fields": {
"description": "Request form values: each name must match a field label on the account's request form.",
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"value": {
"type": "string",
"maxLength": 2000
}
},
"required": [
"name",
"value"
]
}
}
},
"required": [
"title"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴upkeep_approve_request(request_id)
WRITE: approve a pending work request, which converts it into a work order (it may notify the assignee). Needs a token whose role may approve requests. Approving a request that is already approved or declined fails with HTTP 409. POST /requests/{id}/approve.
Input Schema
{
"type": "object",
"properties": {
"request_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep request id (a short string such as \"HW2I379ErS\")."
}
},
"required": [
"request_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴upkeep_create_work_order(title, description, priority, category, start_date, ...)
WRITE: create a new work order (it may notify the assignee and appears in UpKeep's work order board). Ids for asset, location and assignee come from the list tools. POST /work-orders.
Input Schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 250,
"description": "Short title, e.g. Repair sink."
},
"description": {
"type": "string",
"maxLength": 5000
},
"priority": {
"type": "integer",
"minimum": 0,
"maximum": 3,
"description": "Priority: 0 none/lowest, 1 low, 2 medium, 3 high."
},
"category": {
"description": "Must be one of the account's configured work order categories.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"start_date": {
"description": "Start date, ISO 8601.",
"type": "string"
},
"due_date": {
"description": "Due date, ISO 8601.",
"type": "string"
},
"asset": {
"description": "Asset id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"location": {
"description": "Location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assigned_to_user": {
"description": "User id to assign.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"estimated_duration_hours": {
"type": "number",
"minimum": 0,
"maximum": 100000
}
},
"required": [
"title"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴upkeep_update_work_order(work_order_id, status, title, description, priority, ...)
WRITE: change fields of an existing work order: status (open, onHold, inProgress, complete), title, description, priority, due date or assignee. Only the fields you pass change; completing a work order may trigger the account's integrations (for example Zapier). Archiving and deleting are not offered. PATCH /work-orders/{id}.
Input Schema
{
"type": "object",
"properties": {
"work_order_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep work order id (a short string such as \"HW2I379ErS\")."
},
"status": {
"type": "string",
"enum": [
"open",
"onHold",
"inProgress",
"complete"
]
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 250
},
"description": {
"type": "string",
"maxLength": 5000
},
"priority": {
"type": "integer",
"minimum": 0,
"maximum": 3,
"description": "Priority: 0 none/lowest, 1 low, 2 medium, 3 high."
},
"due_date": {
"description": "Due date, ISO 8601.",
"type": "string"
},
"assigned_to_user": {
"description": "User id to assign.",
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"work_order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴upkeep_add_work_order_message(work_order_id, text)
WRITE: post a message (comment) on a work order's activity thread; people following the work order may be notified. POST /work-orders/{id}/update-messages.
Input Schema
{
"type": "object",
"properties": {
"work_order_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep work order id (a short string such as \"HW2I379ErS\")."
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 5000,
"description": "The message text."
}
},
"required": [
"work_order_id",
"text"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴upkeep_update_part_quantity(part_id, quantity, minimum_quantity)
WRITE: set the quantity on hand (and optionally the minimum quantity that triggers a low-stock notification) of a part. This overwrites the stored number: read the part first and pass the new total, not the difference. PATCH /parts/{id}.
Input Schema
{
"type": "object",
"properties": {
"part_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep part id (a short string such as \"HW2I379ErS\")."
},
"quantity": {
"type": "number",
"minimum": 0,
"maximum": 1000000000,
"description": "The new quantity on hand (a total)."
},
"minimum_quantity": {
"description": "New low-stock threshold.",
"type": "number",
"minimum": 0,
"maximum": 1000000000
}
},
"required": [
"part_id",
"quantity"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_users(email, account_type, created_after, created_before, updated_after, ...)
List UpKeep users (technicians, admins, requesters) with account type, job title, status and last login. Use the ids to assign work orders. GET /users.
Input Schema
{
"type": "object",
"properties": {
"email": {
"description": "Only the user with this email.",
"type": "string",
"minLength": 1,
"maxLength": 254
},
"account_type": {
"description": "Only users with this account type.",
"type": "string",
"enum": [
"ADMIN",
"TECH",
"LIMITED_TECH",
"VIEW_ONLY",
"REQUESTER"
]
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_get_user(user_id)
One user by id. GET /users/{id}.
Input Schema
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep user id (a short string such as \"HW2I379ErS\")."
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_teams(name, offset, limit)
List teams with name and description. Use the ids to assign work. GET /teams.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only teams with exactly this name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_vendors(business_name, offset, limit)
List vendors (suppliers and contractors) with contact details. GET /vendors.
Input Schema
{
"type": "object",
"properties": {
"business_name": {
"description": "Only vendors with exactly this business name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_customers(name, offset, limit)
List customers (the parties whose assets or locations you maintain) with contact details. GET /customers.
Input Schema
{
"type": "object",
"properties": {
"name": {
"description": "Only customers with exactly this name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_purchase_orders(status, title, vendor, category, due_after, ...)
List purchase orders with status (awaiting, approved, declined, fulfilled), vendor, dates, total cost and quantities. GET /purchase-orders.
Input Schema
{
"type": "object",
"properties": {
"status": {
"description": "Only purchase orders in this status.",
"type": "string",
"enum": [
"awaiting",
"approved",
"declined",
"fulfilled"
]
},
"title": {
"description": "Only purchase orders with exactly this title.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"vendor": {
"description": "Only records for this vendor id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"category": {
"description": "Only this purchase order category.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"due_after": {
"description": "Due at or after this time. ISO 8601.",
"type": "string"
},
"due_before": {
"description": "Due at or before this time. ISO 8601.",
"type": "string"
},
"created_after": {
"description": "Created at or after this time. ISO 8601.",
"type": "string"
},
"created_before": {
"description": "Created at or before this time. ISO 8601.",
"type": "string"
},
"updated_after": {
"description": "Updated at or after this time. ISO 8601.",
"type": "string"
},
"updated_before": {
"description": "Updated at or before this time. ISO 8601.",
"type": "string"
},
"order_by": {
"description": "Sort: \"<field> ASC|DESC\" with field one of createdAt, updatedAt, dueDate, poDate, fulfilledAt, approvedAt, declinedAt (default \"createdAt DESC\").",
"type": "string",
"pattern": "^[A-Za-z]+ (ASC|DESC)$"
},
"includes": {
"description": "Expand referenced records inline instead of returning ids. Allowed: vendor, createdByUser, approvedByUser, fulfilledByUser, declinedByUser.",
"maxItems": 12,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[A-Za-z.]+$"
}
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_get_purchase_order(purchase_order_id)
One purchase order by id with its parts, quantities, costs and shipping details. GET /purchase-orders/{id}.
Input Schema
{
"type": "object",
"properties": {
"purchase_order_id": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "UpKeep purchase order id (a short string such as \"HW2I379ErS\")."
}
},
"required": [
"purchase_order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢upkeep_list_preventive_maintenance(search, asset, location, assignee, team, ...)
List preventive maintenance (PM) templates, the recurring work that generates scheduled work orders, with their schedules. Filter by text, asset, location, assignee, team or priority. Pages are 1-based. GET /pm.
Input Schema
{
"type": "object",
"properties": {
"search": {
"description": "Text to find in the PM's name or description.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"asset": {
"description": "Only records for this asset id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"location": {
"description": "Only records for this location id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"assignee": {
"description": "Only records for this assigned user id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"team": {
"description": "Only records for this team id.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"priority": {
"type": "integer",
"minimum": 0,
"maximum": 3,
"description": "Priority: 0 none/lowest, 1 low, 2 medium, 3 high."
},
"include_schedules": {
"description": "Also return each PM's schedules.",
"type": "boolean"
},
"page": {
"description": "Page number from 1 (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "PMs per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Evidence
Recent observations
verifiedversion not recorded29 tools