Skip to main content
Glama

Workiz MCP Server and API by Cotlet

Record payment in Workiz

workiz_record_payment
Read-onlyIdempotent

Record payment in the user's own Workiz account from ChatGPT, Claude or any AI agent. Returns how to do it in Workiz step by step (screens, buttons, fields) and opens nothing by itself; then do it with the cotlet_browser_* tools in the user's Workiz Cloud Browser. Workiz's official API: Workiz has an official REST API, but only on the Ultimate plan, and it covers jobs, leads, team members and time off (checked 11 Oct 2026).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "workiz_record_payment"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, and the description corroborates this with 'opens nothing by itself'. It adds genuinely new context by describing the return shape (screens, buttons, fields) and the need for a separate browser execution step. It omits prerequisites such as whether the user must already be signed into Workiz.

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?

Front-loaded with the action, then the return behavior, then the execution path — the important information comes first. The final sentence about Workiz's official REST API and plan tier is tangential context that does not directly help an agent call this tool. Overall it is efficient but not waste-free.

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 input or output schema, the description must carry the load, and it does explain what is returned and how the follow-up execution works. It leaves auth/login state and any failure modes unstated. For a simple read-only guide tool this is nearly complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, which is the baseline-4 case. The description does not add or need parameter guidance, and the empty schema is consistent with a guide-style tool.

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 ('Record payment in the user's own Workiz account') and immediately resolves the misleading name by clarifying it returns step-by-step instructions rather than performing the write. It distinguishes itself from the cotlet_browser_* siblings that actually carry out the actions. The official-API sentence slightly dilutes focus but does not obscure the purpose.

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?

Gives explicit sequencing: use this to get the how-to, then execute with cotlet_browser_* in the Workiz Cloud Browser. It also notes the alternative official REST API path and its Ultimate-plan restriction, which helps an agent decide. It does not state a clear 'when not to use' exclusion, so it falls short of a 5.

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.

Resources