Read UpKeep work orders, assets, parts and meters; create requests and work orders. Hosted by usefulapi — connect from Claude, ChatGPT, Cursor, or any MCP client.
Team and Enterprise: an Owner adds the connector for the organization first.
Run this command, then run /mcp in Claude Code to log in:
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"upkeep": {
"url": "https://upkeep.usefulapi.io/mcp"
}
}
}Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"upkeep": {
"type": "http",
"url": "https://upkeep.usefulapi.io/mcp"
}
}
}No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.
Run these commands. The second one opens the login page:
Other MCP clients (Windsurf, Cline, Zed and more): add the URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser. Do not add an Authorization header: see Before you connect.
The login page asks for your UpKeep API token.
An UpKeep admin creates it under Settings > API Tokens > Create token (it starts with uk_pat_ and is shown only once). The token acts with the role you choose for it, so pick the narrowest role that fits; changes it makes are attributed to the token's name. The UpKeep API is available on the Enterprise plan. Your token is used only to call the UpKeep API on your behalf; it is never shown to anyone.
Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your UpKeep API token. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
Turn on the UpKeep connector, then ask in plain words. The AI picks the tools.
| Tool | Type | What it does |
|---|---|---|
upkeep_get_account | read | Check API token 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 | read | 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 | read | 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 | read | 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 | read | 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 | read | List locations List locations (sites, buildings, rooms) with address, barcode, parent location and hierarchy level. GET /locations. |
upkeep_get_location | read | Get location One location by id. GET /locations/{id}. |
upkeep_list_parts | read | List parts (inventory) 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 | read | Get part One part by id with quantity, cost, location and custom fields. GET /parts/{id}. |
upkeep_list_meters | read | 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 | read | Get meter One meter by id. GET /meters/{id}. |
upkeep_list_meter_readings | read | List meter readings Readings recorded for one meter (value, date, who recorded it), newest first. GET /meters/{id}/readings. |
upkeep_add_meter_reading | write | 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 | read | List work 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 | read | Get work 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 | Create work 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 work 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 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 | 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 | 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 | 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 | read | 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 | read | Get user One user by id. GET /users/{id}. |
upkeep_list_teams | read | List teams List teams with name and description. Use the ids to assign work. GET /teams. |
upkeep_list_vendors | read | List vendors List vendors (suppliers and contractors) with contact details. GET /vendors. |
upkeep_list_customers | read | List customers List customers (the parties whose assets or locations you maintain) with contact details. GET /customers. |
upkeep_list_purchase_orders | read | 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 | read | Get purchase order One purchase order by id with its parts, quantities, costs and shipping details. GET /purchase-orders/{id}. |
upkeep_list_preventive_maintenance | read | List preventive maintenance plans 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_usage_status | Usage status (free-tier meter) Report the caller's current usage: the plan, calls used this month, the limit of the plan (the free monthly cap or the Pro fair use limit), remaining, and whether the limit is reached. Read-only; does not count against the meter. | |
upkeep_request_feature | Request a missing feature Tell usefulapi that the user needs something the UpKeep tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter. | |
upkeep_upgrade | Upgrade to Pro (unlimited*) Get Pro: unlimited tool calls (fair use limit: 10,000 a month) on UpKeep (the free tier caps monthly usage). Plans: "monthly" — $9/month; "yearly" — $90/year (2 months free). Cancel any time: Pro then runs to the end of the paid period, so it also suits a one-time job. *A fair use limit applies. For heavy use (near Pro's limit): "plus" or "plus_yearly" — Pro+, $19/month or $190/year, unlimited tool calls (fair use limit: 100,000 a month); an existing Pro subscription changes to Pro+ in place (needs confirm: true; the price difference for the rest of the period is charged at once). Otherwise returns a short link to open in your browser (it opens Stripe Checkout); after payment the account upgrades automatically. Does not count against the meter. | |
upkeep_cancel_subscription | Cancel the Pro subscription Cancel the caller's UpKeep Pro subscription at the end of the paid period (no refund for the current period; Pro continues until then, then the free tier applies). Requires confirm: true. Run upkeep_upgrade later to undo the cancel before the period ends. Does not count against the meter. |
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper user | $9/mo · $90/yr | Unlimited* |
*Pro fair use limit: 10,000 tool calls a month on this server. For more, write to [email protected].
Pro covers this UpKeep server only. Subscribe with upkeep_upgrade (it returns a Stripe Checkout link). Cancel any time with upkeep_cancel_subscription: Pro continues to the end of the paid period, with no refund for the current period, and running upkeep_upgrade before then undoes the cancel. Or write to [email protected].
No. usefulapi is an independent service. It is not affiliated with or endorsed by UpKeep. The server calls the UpKeep API with your own UpKeep access, so it sees only the data that your account can see.
Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.
The login page asks for your UpKeep API token. See Before you connect for where to find it.
No. Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your UpKeep API token. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the UpKeep API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. To stop all access, remove the connector and change or delete these credentials in UpKeep.
Yes, if you approve it. 7 of the 29 UpKeep tools can create or change data. The other 22 are marked read-only. Most MCP clients ask you to approve a tool call before it runs.
The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with unlimited tool calls (fair use limit: 10,000 tool calls a month), for this UpKeep server only. Cancel any time: Pro then runs to the end of the paid period. Run upkeep_usage_status to see how many calls you used.
Ask the AI to run upkeep_upgrade: it returns a Stripe Checkout link. To cancel, run upkeep_cancel_subscription. Pro continues to the end of the paid period.
Tell the AI what you wanted to do. It can send the request with upkeep_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.
Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.
This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.