Skip to content
MCP server

UpKeep MCP by usefulapi

Read UpKeep work orders, assets, parts and meters; create requests and work orders.

Install
Runs
Remotely
Version
1.21.0
Listing updated
4 days ago

About UpKeep MCP by usefulapi

UpKeep MCP by usefulapi is an MCP server. It runs as a hosted remote server, so there is nothing to install locally.

Install

Run in a terminal

claude mcp add --transport http upkeep https://upkeep.usefulapi.io/mcp

Add to Settings → Connectors → Add custom connector

https://upkeep.usefulapi.io/mcp
Install in CursorOpens Cursor, which asks you to confirm. Or add it by hand:

Add to ~/.cursor/mcp.json

{
  "mcpServers": {
    "upkeep": {
      "url": "https://upkeep.usefulapi.io/mcp"
    }
  }
}
Install in VS CodeOpens VS Code, which asks you to confirm. Or add it by hand:

Add to .vscode/mcp.json

{
  "servers": {
    "upkeep": {
      "type": "http",
      "url": "https://upkeep.usefulapi.io/mcp"
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "upkeep": {
      "serverUrl": "https://upkeep.usefulapi.io/mcp"
    }
  }
}

Add to your client's MCP settings (most use this shape)

{
  "mcpServers": {
    "upkeep": {
      "type": "http",
      "url": "https://upkeep.usefulapi.io/mcp"
    }
  }
}

Tools this server provides (29)

Read directly from the server.

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.
upkeep_list_work_orders
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.
upkeep_get_work_order
One work order by id with its checklist items, custom fields, time log, parts and files. GET /work-orders/{id}.
upkeep_list_assets
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.
upkeep_get_asset
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}.
upkeep_list_locations
List locations (sites, buildings, rooms) with address, barcode, parent location and hierarchy level. GET /locations.
upkeep_get_location
One location by id. GET /locations/{id}.
upkeep_list_parts
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.
upkeep_get_part
One part by id with quantity, cost, location and custom fields. GET /parts/{id}.
upkeep_list_meters
List meters (usage counters such as hours, mileage, temperature) with units, reading frequency and the asset or location they belong to. GET /meters.
upkeep_get_meter
One meter by id. GET /meters/{id}.
upkeep_list_meter_readings
Readings recorded for one meter (value, date, who recorded it), newest first. GET /meters/{id}/readings.
upkeep_add_meter_reading
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.
upkeep_list_requests
List work requests submitted by staff or through the request portal (before they become work orders), with status open/approved/rejected. GET /requests.
upkeep_get_request
One work request by id with its form fields and, once approved, the linked work order id. GET /requests/{id}.
upkeep_create_request
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.
upkeep_approve_request
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.
upkeep_create_work_order
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.
upkeep_update_work_order
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}.
upkeep_add_work_order_message
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.
upkeep_update_part_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}.
upkeep_list_users
List UpKeep users (technicians, admins, requesters) with account type, job title, status and last login. Use the ids to assign work orders. GET /users.
upkeep_get_user
One user by id. GET /users/{id}.
upkeep_list_teams
List teams with name and description. Use the ids to assign work. GET /teams.
upkeep_list_vendors
List vendors (suppliers and contractors) with contact details. GET /vendors.
upkeep_list_customers
List customers (the parties whose assets or locations you maintain) with contact details. GET /customers.
upkeep_list_purchase_orders
List purchase orders with status (awaiting, approved, declined, fulfilled), vendor, dates, total cost and quantities. GET /purchase-orders.
upkeep_get_purchase_order
One purchase order by id with its parts, quantities, costs and shipping details. GET /purchase-orders/{id}.
upkeep_list_preventive_maintenance
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.

UpKeep MCP by usefulapi FAQ

How do I add UpKeep MCP by usefulapi to Claude Code?

Run this command in your terminal: claude mcp add --transport http upkeep https://upkeep.usefulapi.io/mcp