Skip to main content
Glama

Workiz MCP by usefulapi

Update a lead

workiz_update_lead
Destructive

WRITE: update fields on an existing lead — status, schedule, contact, address, type, source, notes, tags. Only the fields you pass are sent. Workiz: POST /lead/update/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
CityNoCity.
TagsNoLead tags, e.g. ["estimate", "callback"].
UUIDYesThe lead's UUID (e.g. XYZ56X).
UnitNoUnit / apartment.
EmailNoClient email.
PhoneNoPrimary phone, digits only, e.g. 6195555555.
StateNoState, e.g. CA.
StatusNoNew lead 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.
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.
LeadNotesNoInternal lead notes.
PostalCodeNoPostal / ZIP code.
SecondPhoneNoSecondary phone.
ServiceAreaNoService area, e.g. metro1.
LeadDateTimeNoNew scheduled start. Date-time string, e.g. 2026-10-01T09:00:00.000Z.
SecondPhoneExtNoSecondary phone extension.
LeadEndDateTimeNoNew scheduled end. Date-time string, e.g. 2026-10-01T09:00:00.000Z.

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

A4/5.0
Behavior4/5

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

Annotations only supply destructiveHint=true, so the description's "WRITE" marker and the explicit partial-update semantics (only passed fields are sent, untouched fields are preserved) add real behavioral value beyond the annotation. It still omits side effects such as whether changing Status triggers automation, permission requirements, or error behavior for an unknown UUID.

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?

Two compact sentences, front-loaded with the WRITE semantics and the most decision-relevant fact (partial update), with no filler. The field list is dense but earns its place by scoping what can be changed.

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 26-parameter mutation tool with a single required UUID and no output schema, the description covers the operation, mutation semantics, and endpoint. It is nearly complete, missing only return/confirmation behavior and whether the call fails or partially applies on an invalid field.

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% across all 26 parameters, so the schema already documents every field's meaning and format. The description's field-group list (status, schedule, contact, address, type, source, notes, tags) largely restates what the schema provides and adds no syntax or constraint detail beyond it, so the baseline of 3 applies.

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

Purpose5/5

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

States a specific verb and resource ("update fields on an existing lead") and enumerates the field groups affected, making it immediately distinguishable from workiz_create_lead, workiz_get_lead, and the status-mutating siblings like workiz_activate_lead or workiz_mark_lead_lost. The Workiz endpoint (POST /lead/update/) pins down the underlying operation.

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 description implies the partial-update contract ("Only the fields you pass are sent"), which is useful context for choosing this over a create call. However it gives no explicit when-to-use/when-not guidance and does not point to alternatives such as workiz_mark_lead_lost or workiz_convert_lead_to_job for status changes with dedicated tools.

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.