Skip to main content
Glama

service-report

Raise a work order

work_order_create

Raise a job order and return its WO-YYYY-NNNN number: the client, the site address, the date it was asked for, what the job is and how urgent. Free tier: 5 open orders.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNo
clientYesA client name or id from the invoice server's client records. An unknown name needs client_address as well, so a typo is not filed as a new customer
currencyNoISO code the job is priced in. Defaults to the shared business profile's currency
priorityNoHow urgent the job is. Default normal
descriptionYesWhat the job is, e.g. Replace immersion heater and test
client_emailNo
duplicate_okNoRaise it even though an identical work order exists, for a genuinely repeated visit. Default false
site_addressYesWhere the work happens. This is the site, not the billing address
client_vat_idNo
client_addressNoThe client's billing address, for a client that is not in the invoice records yet
requested_dateYesThe date the work was asked for, YYYY-MM-DD

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already provide readOnlyHint=false and destructiveHint=false, so the description does not need to re-state mutation. It adds the free-tier open-order limit and the return format. However, it does not disclose duplicate-handling behavior (duplicate_ok) or failure conditions, which are material to a create operation.

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?

The description is a single sentence that front-loads the action and return value, then lists the key fields. It is compact and wastes no words, though the colon-list format is a little dense.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 11-parameter create operation with no output schema, the description names the return format and the free-tier limit, but omits the duplicate handling, prerequisite client_address behavior for unknown clients, and any error or rejection conditions. It is acceptable but not complete.

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

Parameters2/5

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

The description merely recites parameter names already present in the schema ('client, site address, date, job, urgency') without adding new semantic detail. Schema coverage is 73% and the schema already documents client, priority, and duplicate_ok. The description adds no extra meaning to any parameter.

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 the exact action ('Raise a job order') and the returned identifier format. The list of fields clarifies scope, and the create action is clearly distinct from siblings like work_order_get or work_order_add_line.

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

Usage Guidelines2/5

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

No guidance on when to use this tool instead of work_order_add_line or work_order_status. The 'Free tier' note is a constraint, not a selection rule. An agent must infer that creation is the right call from the name alone.

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.