Skip to main content
Glama

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. First observed

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, so the risk profile is partly conveyed. The description adds the genuinely useful partial-update semantics (omitted fields are untouched), which is behavioral context beyond the annotations, but it says nothing about overwrite risk, permission requirements, or what an update returns.

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

Conciseness4/5

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

A single well-formed sentence with a WRITE prefix that front-loads the mutation semantics, followed by a terse endpoint note. Nothing is wasted; the endpoint reference is the only slightly extraneous element.

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 that is fully schema-documented with a required UUID and no output schema, the description covers purpose and the partial-update contract. What is missing — failure behavior on a bad UUID, permission needs, whether LeadDateTime changes have side effects — is secondary but not irrelevant.

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 coverage is 100%, so all 26 parameters are already documented in the schema with examples. The description only groups them into loose categories (contact, address, type, source, notes, tags), adding marginal meaning over the schema's own field descriptions. Baseline 3 is appropriate.

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 (update) and resource (an existing lead), then enumerates the field families it can change (status, schedule, contact, address, type, source, notes, tags). This is enough to distinguish it from workiz_create_lead, workiz_get_lead, and workiz_update_job without opening any schema.

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 partial-update contract ('Only the fields you pass are sent') tells the agent how to invoke it, but there is no guidance on when to reach for this tool versus siblings such as workiz_assign_lead, workiz_mark_lead_lost, or workiz_convert_lead_to_job, all of which also mutate a lead. Usage is implied rather than stated.

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.