Skip to main content
Glama

Workiz MCP by usefulapi

List upcoming time off

workiz_list_time_off
Read-only

List FUTURE time off (start, end, userName — 'Entire Business' for company-wide closures). Set all=true to include every user and company time off. Useful before scheduling. Workiz: GET /TimeOff/get/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
allNoInclude all users' and company time off (Workiz default: false).

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.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered; the description adds value beyond that by naming the returned fields (start, end, userName), explaining the 'Entire Business' sentinel for company closures, and citing the backing endpoint. It does not discuss sorting, pagination, or date-window bounds, which a 'future' query would benefit from.

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?

Three short sentences, front-loaded with the verb and scope; the returned-field hint and the all=true rule both earn their space. The trailing endpoint citation ('Workiz: GET /TimeOff/get/') is marginally useful metadata rather than instruction.

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 only one optional parameter and no output schema, the description does the work of explaining what comes back (start, end, userName, company-wide marker) plus the scope toggle. That is sufficient for an agent to call it correctly; only pagination/date-range behavior is unaddressed.

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% and the single parameter's behavior (include all users' and company time off, default false) is already documented in the schema. The description largely restates that semantics rather than adding new meaning, so the baseline of 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 and resource ('List FUTURE time off') and narrows scope with FUTURE and the userName/'Entire Business' distinction, which separates it from the single-user sibling workiz_get_user_time_off. It stops short of naming that sibling explicitly, so it is clear but not fully differentiated by routing language.

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?

'Useful before scheduling' gives an implied context for use, and the all=true sentence gives a clear selection rule. There is no explicit when-not guidance and no named alternative (e.g., workiz_get_user_time_off for a single user), so usage is only partially covered.

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.