Skip to main content
Glama

Workiz MCP by usefulapi

Update a job

workiz_update_job
Destructive

WRITE: update fields on an existing job — status/sub-status, reschedule (JobDateTime/JobEndDateTime), contact, address, type, source, notes, tags. Only the fields you pass are sent. Workiz: POST /job/update/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
CityNoCity.
TagsNoJob tags, e.g. ["estimate", "callback"].
UUIDYesThe job's UUID (e.g. XYZ56X).
UnitNoUnit / apartment.
EmailNoClient email.
PhoneNoPrimary phone, digits only, e.g. 6195555555.
StateNoState, e.g. CA.
StatusNoNew job status, e.g. "In progress".
AddressNoStreet address, e.g. 123 W Main Street.
CompanyNoClient company name.
CountryNoCountry code, e.g. US.
JobTypeNoJob type, e.g. Repair.
ClientIdNoExisting Workiz client id to attach this to.
JobNotesNoInternal job notes.
LastNameNoClient last name.
PhoneExtNoPrimary phone extension.
TimezoneNoTimezone, e.g. US/Pacific.
CreatedByNoName recorded as the creator.
FirstNameNoClient first name.
JobSourceNoLead/job source, e.g. Google.
SubStatusNoNew job sub-status.
PostalCodeNoPostal / ZIP code.
JobDateTimeNoNew scheduled start. Date-time string, e.g. 2026-10-01T09:00:00.000Z.
SecondPhoneNoSecondary phone.
ServiceAreaNoService area, e.g. metro1.
JobEndDateTimeNoNew scheduled end. Date-time string, e.g. 2026-10-01T09:00:00.000Z.
SecondPhoneExtNoSecondary phone extension.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only supply destructiveHint=true; the description adds the materially useful behavioral fact that this is a partial update which leaves unpassed fields untouched, and labels the operation as a WRITE. It still doesn't disclose permission/authorization requirements, whether changes are reversible or notification-triggering, or what happens when ClientId reattaches a job to a different client.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three terse fragments, front-loaded with the WRITE marker and the action, then the field groups, then the backing endpoint. Every clause carries information and nothing is padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 27-parameter mutation with no output schema and only a destructiveHint annotation, the description covers the essential call-correctness facts (required UUID via schema, partial-update semantics, writable field families). Remaining gaps are side-effect and failure behavior, which the annotations do not carry either.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all 27 parameters with examples. The description's field-group summary (status/sub-status, reschedule, contact, address, type, source, notes, tags) organizes but does not add meaning beyond what the schema provides, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource (update fields on an existing job) and enumerates the updatable field groups, so an agent can immediately tell this is a partial-update mutation on an existing record rather than a create. It stops short of naming a sibling alternative (e.g. workiz_assign_job for assignment-only changes), so differentiation is inferred from 'existing job' rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The 'Only the fields you pass are sent' clause implies the correct usage pattern for a PATCH-style update, but there is no explicit when-to-use guidance or any statement of when to prefer workiz_assign_job / workiz_unassign_job / workiz_update_lead over this tool. Usage is implied rather than directed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.