# FieldEdge MCP by usefulapi

> FieldEdge MCP by usefulapi is an MCP server. Read work orders, customers and invoices; create customers, notes and work orders in FieldEdge. It runs as a hosted remote server, so there is nothing to install locally.

- **Kind:** MCP server
- **Website:** https://usefulapi.io/fieldedge/
- **Repository:** https://github.com/m190/usefulapi-mcp/tree/HEAD/servers/fieldedge
- **MCP Registry name:** io.usefulapi/fieldedge
- **Listing updated:** 2026-11-13

## About

Read work orders, customers and invoices; create customers, notes and work orders in FieldEdge.

## Install

### Claude Code (Terminal)

```sh
claude mcp add --transport http fieldedge https://fieldedge.usefulapi.io/mcp
```

### Claude Desktop (Settings → Connectors → Add custom connector)

```sh
https://fieldedge.usefulapi.io/mcp
```

### Cursor (~/.cursor/mcp.json)

```json
{
  "mcpServers": {
    "fieldedge": {
      "url": "https://fieldedge.usefulapi.io/mcp"
    }
  }
}
```

### VS Code (.vscode/mcp.json)

```json
{
  "servers": {
    "fieldedge": {
      "type": "http",
      "url": "https://fieldedge.usefulapi.io/mcp"
    }
  }
}
```

### Windsurf (~/.codeium/windsurf/mcp_config.json)

```json
{
  "mcpServers": {
    "fieldedge": {
      "serverUrl": "https://fieldedge.usefulapi.io/mcp"
    }
  }
}
```

### Other clients (your client's MCP settings (most use this shape))

```json
{
  "mcpServers": {
    "fieldedge": {
      "type": "http",
      "url": "https://fieldedge.usefulapi.io/mcp"
    }
  }
}
```

## Tools

- `fieldedge_list_work_orders`: List work orders (jobs) of the company with status, service address, customer, primary technician and linked invoice. Filters combine with AND; assigned=false cannot be combined with primary_tech_id. Needs scope workorders:read. GET /open-api/v1/work-orders.
- `fieldedge_get_work_order`: One work order: status, assignments, service address, task, tags and linked invoice. Needs scope workorders:read. GET /open-api/v1/work-orders/{work_order_id}.
- `fieldedge_search_work_orders_by_address`: Work orders at a service address, most recent first, each with its customer's name. All of address_line_1, city, state and postal_code are required. Needs scope workorders:read. GET /open-api/v1/work-orders/search/by-address.
- `fieldedge_list_work_order_assignments`: Technician assignments (schedule, status) on one work order. Needs scope workorders:read. GET /open-api/v1/work-orders/{workOrderId}/assignments.
- `fieldedge_search_customers`: Search customers (personal data). With no filter all customers are listed. Needs scope customers:read. GET /open-api/v1/customers/search.
- `fieldedge_get_customer`: One customer (or job location) by id, with contact details and address (personal data). The reply says whether the record is a job or a billing customer. Needs scope customers:read. GET /open-api/v1/customers/id/{customer_id}.
- `fieldedge_get_customer_by_phone`: The customer with this phone number (personal data). Needs scope customers:read. GET /open-api/v1/customer/{phone}.
- `fieldedge_search_customers_by_address`: Customers at a street address (personal data). address_line_1, city, state and postal_code are required. Needs scope customers:read. GET /open-api/v1/customers/by-address.
- `fieldedge_list_customer_notes`: Notes on a customer record, newest first by default. Needs scope customers:read. GET /open-api/v1/customers/{customerId}/notes.
- `fieldedge_list_customer_attachments`: File attachments on a customer record, each with the blob URL to view or download it. Needs scope customers:read. GET /open-api/v1/customers/{customerId}/attachments.
- `fieldedge_list_tags`: Reusable customer tags of the account. Needs scope customers:read. GET /open-api/v1/tags.
- `fieldedge_list_invoices`: Invoices by invoice date, without line items (use fieldedge_get_invoice for those). Needs scope invoices:read. GET /open-api/v1/invoices.
- `fieldedge_get_invoice`: One invoice with its line items; the invoice id equals its work order id. Needs scope invoices:read. GET /open-api/v1/invoices/{invoice_id}.
- `fieldedge_list_quotes`: Quotes, without line items (use fieldedge_get_quote for those). Prefer class_id over class_name. Needs scope workorders:read. GET /open-api/v1/quotes.
- `fieldedge_get_quote`: One quote with its line items; the quote id equals its work order id. Needs scope workorders:read. GET /open-api/v1/quotes/{quote_id}.
- `fieldedge_list_agreements`: Service agreements (recurring maintenance contracts) with plan, dates and customer. Needs scope workorders:read. GET /open-api/v1/agreements.
- `fieldedge_get_agreement`: One service agreement by id. Needs scope workorders:read. GET /open-api/v1/agreements/{agreement_id}.
- `fieldedge_list_employees`: Employees (technicians, dispatchers, CSRs, admins). Needs scope employees:read. GET /open-api/v1/employees.
- `fieldedge_get_employee`: One employee record. Needs scope employees:read. GET /open-api/v1/employees/{employee_id}.
- `fieldedge_list_business_units`: Business units (needed to create a work order). Needs scope business-units:read. GET /open-api/v1/business-units.
- `fieldedge_get_business_unit`: One business unit by id. Needs scope business-units:read. GET /open-api/v1/business-units/{business_unit_id}.
- `fieldedge_list_lead_sources`: Lead sources (needed to create a work order). Needs scope lead-sources:read. GET /open-api/v1/lead-sources.
- `fieldedge_get_lead_source`: One lead source by id. Needs scope lead-sources:read. GET /open-api/v1/lead-sources/{lead_source_id}.
- `fieldedge_list_tasks`: Tasks (service types, needed to create a work order). Needs scope tasks:read. GET /open-api/v1/tasks.
- `fieldedge_get_task_bundle`: One task together with its resolved department and skill. Needs scope tasks:read. GET /open-api/v1/tasks/{task_id}/bundle.
- `fieldedge_list_items`: Inventory items (parts, services) with cost and rate. Needs scope items:read. GET /open-api/v1/items.
- `fieldedge_get_item`: One inventory item by id. Needs scope items:read. GET /open-api/v1/items/{item_id}.
- `fieldedge_list_item_categories`: Inventory item categories (tree: childTreeLevel, parent). Needs scope item-categories:read. GET /open-api/v1/item-categories.
- `fieldedge_get_item_category`: One item category by id. Needs scope item-categories:read. GET /open-api/v1/item-categories/{item_category_id}.
- `fieldedge_list_sales_tax_codes`: Sales tax codes. Needs scope items:read. GET /open-api/v1/sales-tax-codes.
- `fieldedge_list_warehouses`: Inventory warehouses. Needs scope warehouses:read. GET /open-api/v1/warehouses.
- `fieldedge_get_warehouse`: One warehouse by id. Needs scope warehouses:read. GET /open-api/v1/warehouses/{warehouse_id}.
- `fieldedge_get_lead`: One lead by id (lead-provider integrations). Needs scope leads:read. GET /open-api/v1/leads/{lead_id}.
- `fieldedge_get_company`: The company name for a company id (the tenant id). Needs scope company:read. GET /open-api/v1/companies/{company_id}.
- `fieldedge_create_customer`: WRITE: create a customer record in FieldEdge, visible to the office staff at once. Needs an e-mail or a phone number (international format, e.g. +14155552671); marketing_email_opt_in needs an e-mail and marketing_sms_opt_in a phone number. Names are 2-50 characters without digits. Check fieldedge_search_customers first so you do not create a duplicate. Needs scope customers:write. POST /open-api/v
- `fieldedge_create_customer_note`: WRITE: add a free-text note to a customer record; office staff see it in FieldEdge at once. Needs scope customers:write. POST /open-api/v1/customers/{customerId}/notes.
- `fieldedge_update_customer_note`: WRITE: replace the text of an existing customer note (the old text is lost). Get the note id from fieldedge_list_customer_notes. Needs scope customers:write. PATCH /open-api/v1/customers/{customerId}/notes/{noteId}.
- `fieldedge_create_tag`: WRITE: create a reusable customer tag (e.g. "VIP Customer"). Check fieldedge_list_tags first. Needs scope customers:write. POST /open-api/v1/tags.
- `fieldedge_add_customer_tag`: WRITE: attach an existing tag to a customer; it shows on the customer record in FieldEdge. Needs scope customers:write. POST /open-api/v1/customers/{customerId}/tags.
- `fieldedge_remove_customer_tag`: WRITE: detach a tag from a customer (the tag itself stays). Needs scope customers:write. DELETE /open-api/v1/customers/{customerId}/tags/{tagId}.
- `fieldedge_create_work_order`: WRITE: create a work order for a customer location. business_unit_id, lead_source_id and task_id are required: get them from fieldedge_list_business_units, fieldedge_list_lead_sources and fieldedge_list_tasks. Scheduling, invoice lines and equipment are separate steps (fieldedge_assign_technician for scheduling). Needs scope workorders:write. POST /open-api/v1/work-orders.
- `fieldedge_update_work_order`: WRITE: partially update a work order; only the fields you pass change. Can reassign the primary technician, change description/notes, and mark it completed (with a resolution) or cancel it (cancel_note). Look at fieldedge_get_work_order first. Needs scope workorders:write. PATCH /open-api/v1/work-orders/{workOrderId}.
- `fieldedge_assign_technician`: WRITE: schedule a technician on a work order. The assignment appears on the Dispatch Board at once and FieldEdge returns no assignment id: list the assignments afterwards to find it. Needs scope workorders:write. POST /open-api/v1/work-orders/{workOrderId}/assignments.
- `fieldedge_update_assignment_status`: WRITE: move an assignment to pending, traveling, working, paused, completed or canceled. It triggers the same customer notifications and dispatch-board updates as a change on the dispatch board and is timestamped now. Canceling needs cancel_note; it fails once the assignment is completed, canceled or finalized. Get the assignment id from fieldedge_list_work_order_assignments. Needs scope workorder
- `fieldedge_remove_assignment`: WRITE: unassign one technician (by assignment id) from a work order; other technicians on it stay. Get the assignment id from fieldedge_list_work_order_assignments. Needs scope workorders:write. DELETE /open-api/v1/work-orders/{workOrderId}/assignments/{assignmentId}.

## FAQ

### How do I add FieldEdge MCP by usefulapi to Claude Code?

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

---
Source: https://ai-powered.com/mcp/fieldedge-mcp-by-usefulapi
