Field Service Business Platform by Doing Work

schedule_setRules

Change the shop's scheduling rules (owner or office; the time zone is owner only). arrival_window_minutes is the default window customers are told for new visits (0 means an exact time). buffer_minutes is travel and setup time find-a-time keeps clear around booked visits. reminder_hours is how long before a visit the customer gets an appointment reminder (0 turns reminders off). on_my_way_notices tells the customer by text and by email when a worker says they are on the way. Text is the main one. The email goes whenever the customer has an email address, even if the text does not. arrival_notices (off by default) adds an arrival time to that message when one is known (a stored route estimate, or the time the worker entered; route data has no drive time, so with no worker time there is no arrival line). The arrived text and email follow on_my_way_notices, the same setting as the on the way message. A do-not-email address is not emailed. Only the fields you send change. Visits already booked keep their window and reminder.

Input Schema

Name	Required	Description
`shop_id`	Yes
`time_zone`	No	IANA zone name, for example America/Boise.
`buffer_minutes`	No
`reminder_hours`	No
`arrival_notices`	No	When true, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered). Off by default. The arrived notice follows on_my_way_notices. No drive time is looked up.
`on_my_way_notices`	No
`arrival_window_minutes`	No

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedNov 3, 2026

changedInput schema / properties / arrival_notices / description

Previous value: -"When true, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered), and the customer is told by text and email when the worker marks the visit arrived. Off by default. No drive time is looked up."New value: +"When true, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered). Off by default. The arrived notice follows on_my_way_notices. No drive time is looked up."

changedOutput schema / anyOf

Previous value: -[
-  {
-    "properties": {
-      "arrival_notices": {
-        "description": "When true, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered), and the customer is told by text and email when the worker marks the visit arrived. Off by default. No drive time is looked up.",
-        "type": "boolean"
-      },
-      "arrival_window_minutes": {
-        "type": "integer"
-      },
-      "buffer_minutes": {
-        "type": "integer"
-      },
-      "hours": {
-        "items": {
-          "properties": {
-            "end": {
-              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
-              "type": "string"
-            },
-            "start": {
-              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
-              "type": "string"
-            },
-            "weekday": {
-              "maximum": 6,
-              "minimum": 0,
-              "type": "integer"
-            }
-          },
-          "required": [
-            "weekday",
-            "start",
-            "end"
-          ],
-          "type": "object"
-        },
-        "type": "array"
-      },
-      "hours_source": {
-        "description": "default means the shop set no hours and Monday to Friday 08:00 to 17:00 is assumed.",
-        "enum": [
-          "shop",
-          "default"
-        ],
-        "type": "string"
-      },
-      "on_my_way_notices": {
-        "type": "boolean"
-      },
-      "reminder_hours": {
-        "description": "0 means no appointment reminders.",
-        "type": "integer"
-      },
-      "shop_id": {
-        "format": "uuid",
-        "type": "string"
-      },
-      "time_zone": {
-        "description": "IANA zone all shop-local times use.",
-        "type": "string"
-      },
-      "time_zone_set": {
-        "description": "False when the zone comes from the shop's jurisdiction.",
-        "type": "boolean"
-      }
-    },
-    "required": [
-      "shop_id",
-      "time_zone",
-      "hours",
-      "hours_source",
-      "arrival_window_minutes",
-      "buffer_minutes",
-      "reminder_hours",
-      "on_my_way_notices",
-      "arrival_notices"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "approval_id": {
-        "format": "uuid",
-        "type": "string"
-      },
-      "approval_required": {
-        "enum": [
-          true
-        ],
-        "type": "boolean"
-      },
-      "expires_at": {
-        "format": "date-time",
-        "type": "string"
-      },
-      "message": {
-        "type": "string"
-      },
-      "status": {
-        "enum": [
-          "pending"
-        ],
-        "type": "string"
-      }
-    },
-    "required": [
-      "approval_required",
-      "approval_id",
-      "status",
-      "expires_at",
-      "message"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "properties": {
+      "arrival_notices": {
+        "description": "When true, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered). Off by default. The arrived notice follows on_my_way_notices. No drive time is looked up.",
+        "type": "boolean"
+      },
+      "arrival_window_minutes": {
+        "type": "integer"
+      },
+      "buffer_minutes": {
+        "type": "integer"
+      },
+      "hours": {
+        "items": {
+          "properties": {
+            "end": {
+              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
+              "type": "string"
+            },
+            "start": {
+              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
+              "type": "string"
+            },
+            "weekday": {
+              "maximum": 6,
+              "minimum": 0,
+              "type": "integer"
+            }
+          },
+          "required": [
+            "weekday",
+            "start",
+            "end"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "hours_source": {
+        "description": "default means the shop set no hours and Monday to Friday 08:00 to 17:00 is assumed.",
+        "enum": [
+          "shop",
+          "default"
+        ],
+        "type": "string"
+      },
+      "on_my_way_notices": {
+        "type": "boolean"
+      },
+      "reminder_hours": {
+        "description": "0 means no appointment reminders.",
+        "type": "integer"
+      },
+      "shop_id": {
+        "format": "uuid",
+        "type": "string"
+      },
+      "time_zone": {
+        "description": "IANA zone all shop-local times use.",
+        "type": "string"
+      },
+      "time_zone_set": {
+        "description": "False when the zone comes from the shop's jurisdiction.",
+        "type": "boolean"
+      }
+    },
+    "required": [
+      "shop_id",
+      "time_zone",
+      "hours",
+      "hours_source",
+      "arrival_window_minutes",
+      "buffer_minutes",
+      "reminder_hours",
+      "on_my_way_notices",
+      "arrival_notices"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "approval_id": {
+        "format": "uuid",
+        "type": "string"
+      },
+      "approval_required": {
+        "enum": [
+          true
+        ],
+        "type": "boolean"
+      },
+      "expires_at": {
+        "format": "date-time",
+        "type": "string"
+      },
+      "message": {
+        "type": "string"
+      },
+      "status": {
+        "enum": [
+          "pending"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "approval_required",
+      "approval_id",
+      "status",
+      "expires_at",
+      "message"
+    ],
+    "type": "object"
+  }
+]

Changed2 schema fields changedNov 2, 2026

addedInput schema / properties / arrival_notices

Added value: +{
+  "description": "When true, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered), and the customer is told by text and email when the worker marks the visit arrived. Off by default. No drive time is looked up.",
+  "type": "boolean"
+}

changedOutput schema / anyOf

Previous value: -[
-  {
-    "properties": {
-      "arrival_window_minutes": {
-        "type": "integer"
-      },
-      "buffer_minutes": {
-        "type": "integer"
-      },
-      "hours": {
-        "items": {
-          "properties": {
-            "end": {
-              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
-              "type": "string"
-            },
-            "start": {
-              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
-              "type": "string"
-            },
-            "weekday": {
-              "maximum": 6,
-              "minimum": 0,
-              "type": "integer"
-            }
-          },
-          "required": [
-            "weekday",
-            "start",
-            "end"
-          ],
-          "type": "object"
-        },
-        "type": "array"
-      },
-      "hours_source": {
-        "description": "default means the shop set no hours and Monday to Friday 08:00 to 17:00 is assumed.",
-        "enum": [
-          "shop",
-          "default"
-        ],
-        "type": "string"
-      },
-      "on_my_way_notices": {
-        "type": "boolean"
-      },
-      "reminder_hours": {
-        "description": "0 means no appointment reminders.",
-        "type": "integer"
-      },
-      "shop_id": {
-        "format": "uuid",
-        "type": "string"
-      },
-      "time_zone": {
-        "description": "IANA zone all shop-local times use.",
-        "type": "string"
-      },
-      "time_zone_set": {
-        "description": "False when the zone comes from the shop's jurisdiction.",
-        "type": "boolean"
-      }
-    },
-    "required": [
-      "shop_id",
-      "time_zone",
-      "hours",
-      "hours_source",
-      "arrival_window_minutes",
-      "buffer_minutes",
-      "reminder_hours",
-      "on_my_way_notices"
-    ],
-    "type": "object"
-  },
-  {
-    "properties": {
-      "approval_id": {
-        "format": "uuid",
-        "type": "string"
-      },
-      "approval_required": {
-        "enum": [
-          true
-        ],
-        "type": "boolean"
-      },
-      "expires_at": {
-        "format": "date-time",
-        "type": "string"
-      },
-      "message": {
-        "type": "string"
-      },
-      "status": {
-        "enum": [
-          "pending"
-        ],
-        "type": "string"
-      }
-    },
-    "required": [
-      "approval_required",
-      "approval_id",
-      "status",
-      "expires_at",
-      "message"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "properties": {
+      "arrival_notices": {
+        "description": "When true, an on the way message includes an arrival time when one is known (a stored route estimate, or the time the worker entered), and the customer is told by text and email when the worker marks the visit arrived. Off by default. No drive time is looked up.",
+        "type": "boolean"
+      },
+      "arrival_window_minutes": {
+        "type": "integer"
+      },
+      "buffer_minutes": {
+        "type": "integer"
+      },
+      "hours": {
+        "items": {
+          "properties": {
+            "end": {
+              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
+              "type": "string"
+            },
+            "start": {
+              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
+              "type": "string"
+            },
+            "weekday": {
+              "maximum": 6,
+              "minimum": 0,
+              "type": "integer"
+            }
+          },
+          "required": [
+            "weekday",
+            "start",
+            "end"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "hours_source": {
+        "description": "default means the shop set no hours and Monday to Friday 08:00 to 17:00 is assumed.",
+        "enum": [
+          "shop",
+          "default"
+        ],
+        "type": "string"
+      },
+      "on_my_way_notices": {
+        "type": "boolean"
+      },
+      "reminder_hours": {
+        "description": "0 means no appointment reminders.",
+        "type": "integer"
+      },
+      "shop_id": {
+        "format": "uuid",
+        "type": "string"
+      },
+      "time_zone": {
+        "description": "IANA zone all shop-local times use.",
+        "type": "string"
+      },
+      "time_zone_set": {
+        "description": "False when the zone comes from the shop's jurisdiction.",
+        "type": "boolean"
+      }
+    },
+    "required": [
+      "shop_id",
+      "time_zone",
+      "hours",
+      "hours_source",
+      "arrival_window_minutes",
+      "buffer_minutes",
+      "reminder_hours",
+      "on_my_way_notices",
+      "arrival_notices"
+    ],
+    "type": "object"
+  },
+  {
+    "properties": {
+      "approval_id": {
+        "format": "uuid",
+        "type": "string"
+      },
+      "approval_required": {
+        "enum": [
+          true
+        ],
+        "type": "boolean"
+      },
+      "expires_at": {
+        "format": "date-time",
+        "type": "string"
+      },
+      "message": {
+        "type": "string"
+      },
+      "status": {
+        "enum": [
+          "pending"
+        ],
+        "type": "string"
+      }
+    },
+    "required": [
+      "approval_required",
+      "approval_id",
+      "status",
+      "expires_at",
+      "message"
+    ],
+    "type": "object"
+  }
+]

First observedNov 1, 2026

TDQS

A3.7/5.0

Behavior3/5

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

With no annotations, the description carries the full burden and does disclose several behaviors: partial-update semantics, default values (arrival_notices off, 0 disables windows/reminders), and that existing booked visits keep their window and reminder. It omits whether changes are reversible, whether there is an audit trail, and what a failed/partial update looks like.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose and permission scope are front-loaded, which is good, but the body is a long unstructured prose block that re-explains arrival_notices twice and dwells on route-estimate internals. The information is useful but could be tightened substantially without losing meaning.

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?

For a 7-parameter mutation with no annotations and an output schema that covers return values, the description supplies what structured fields do not: update semantics, defaults, and the effect on already-booked visits. Only the reversibility and error/validation story are missing.

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

Parameters5/5

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

Schema coverage is only 29%, yet the description explains every undocumented parameter: arrival_window_minutes as the customer-facing default window with 0 meaning an exact time, buffer_minutes as travel/setup padding kept clear by find-a-time, reminder_hours as lead time with 0 disabling reminders, and on_my_way_notices as the text-plus-email on-the-way trigger. It adds genuine meaning beyond the schema, including edge cases like do-not-email addresses and missing drive-time data.

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 ('Change the shop's scheduling rules') and immediately scopes it with permission requirements (owner or office; time zone is owner only). It is clearly a mutation of shop-wide scheduling defaults, distinguishable from visit-level tools, though it never names the read-side sibling schedule_settings as the counterpart.

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?

Gives a real prerequisite (owner/office privileges, with time_zone restricted to owner) and states the partial-update contract 'Only the fields you send change', which tells the agent how to call it safely. It offers no explicit when-to-use vs. when-not guidance and does not route the agent to schedule_settings for reading current values before writing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Field Service Business Platform by Doing Work tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?