Skip to main content
Glama

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

TDQS

A4.2/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, so the bar is lower. The description adds genuinely new context: the future-only time window, the returned fields, and the 'Entire Business' sentinel value for company-wide closures — all useful given there is no output schema.

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?

Four short clauses, each load-bearing: scope, return shape, sentinel value, parameter behavior, usage hint, and the underlying endpoint. Front-loaded with the most important constraint (FUTURE) first.

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 correctly compensates by naming the returned fields and the company-wide sentinel. Nothing critical is missing for a read-only list tool, though ordering and pagination behavior are unstated.

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% and the single all parameter is already documented in the schema, including the default. The description restates the same semantics without adding syntax or edge-case detail, so 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 (list time off) with an explicit scope qualifier — FUTURE only — and names the returned fields (start, end, userName). This distinguishes it from the sibling workiz_get_user_time_off, which is a per-user retrieval rather than an upcoming-list.

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

Usage Guidelines4/5

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

'Useful before scheduling' gives a concrete usage context, and the all=true sentence clarifies the main branching decision. It does not, however, explicitly name alternatives or state when not to use the tool.

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.