Skip to main content
Glama

Get one lead

workiz_get_lead
Read-only

Fetch one lead by UUID: schedule, status, client contact and address, source, notes and assigned team. Workiz: GET /lead/get/{UUID}/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesThe lead's UUID (e.g. XYZ56X).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so safety is covered. The description goes beyond that by enumerating which fields the record contains and citing the underlying endpoint (GET /lead/get/{UUID}/), which adds real context about the response shape.

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 front-loaded sentence enumerates returned fields efficiently, followed by a short endpoint reference. The endpoint line is mildly redundant but aids API mapping, so it still earns most of its space.

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?

With no output schema, the description compensates by listing the fields returned, and it names the UUID lookup and underlying API path. It is essentially complete for a simple one-parameter read, missing only error/not-found behavior.

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?

Only one parameter with 100% schema description coverage, so the schema already documents the uuid fully (including an example). The description adds no format or constraint detail beyond 'by UUID', so the baseline 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 ('Fetch one lead by UUID') and explicitly scopes to a single record, distinguishing it from siblings like workiz_list_leads. The listed fields (schedule, status, contact, address, source, notes, team) further pin down what entity is retrieved.

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 'by UUID' phrasing implies the retrieval-by-identifier use case, but there is no explicit when-to-use vs workiz_list_leads or the update/convert siblings, and no prerequisites or exclusions are stated. Usage is inferable but not guided.

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.