Skip to main content
Glama

calendar.settings.watch

Monitor Calendar Settings resources for changes by creating a watch channel via HTTP POST; returns the API response as JSON. Blocked in readonly profiles.

Instructions

Watch for changes to Settings resources [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON Channel object accepting address, expiration, id, kind, params, payload, resourceId, resourceUri and 2 more fields; pass it via params or whole via body_file Siblings over the same resource: get, list.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON Channel object.
pageTokenNo[query parameter] Token specifying which result page to return. Optional.
syncTokenNo[query parameter] Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contai
maxResultsNo[query parameter] Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
request_bodyNoRequest body of type Channel: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
idNo
kindNo
typeNo
tokenNo
paramsNo
addressNo
payloadNo
expirationNo
resourceIdNo
resourceUriNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / body_file / description
      Previous value: -"Read the request body from this file ('-' for stdin) instead of building one from the parameters."New value: +"Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON Channel object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type Channel: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "address": {
      +      "type": "string"
      +    },
      +    "expiration": {
      +      "type": "string"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "kind": {
      +      "type": "string"
      +    },
      +    "params": {
      +      "type": "object"
      +    },
      +    "payload": {
      +      "type": "boolean"
      +    },
      +    "resourceId": {
      +      "type": "string"
      +    },
      +    "resourceUri": {
      +      "type": "string"
      +    },
      +    "token": {
      +      "type": "string"
      +    },
      +    "type": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed6 schema fields changed
    • changedInput schema / properties / maxResults / description
      Previous value: -"Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional."New value: +"[query parameter] Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional."
    • addedInput schema / properties / maxResults / format
      Added value: +"int32"
    • addedInput schema / properties / maxResults / minimum
      Added value: +1
    • changedInput schema / properties / pageToken / description
      Previous value: -"Token specifying which result page to return. Optional."New value: +"[query parameter] Token specifying which result page to return. Optional."
    • changedInput schema / properties / syncToken / description
      Previous value: -"Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contai"New value: +"[query parameter] Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contai"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "address": {
      +      "type": "string"
      +    },
      +    "expiration": {
      +      "type": "string"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "kind": {
      +      "type": "string"
      +    },
      +    "params": {
      +      "type": "object"
      +    },
      +    "payload": {
      +      "type": "boolean"
      +    },
      +    "resourceId": {
      +      "type": "string"
      +    },
      +    "resourceUri": {
      +      "type": "string"
      +    },
      +    "token": {
      +      "type": "string"
      +    },
      +    "type": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden, and it does most of it: discloses that this is a mutating POST that creates/triggers a change, that it's blocked in read-only mode, and that it returns the API response resource as JSON. It stops short of explaining channel expiration/renewal lifecycle or how to stop the channel, which matters for a watch 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?

Front-loads the verb, resource, method, and the read-only caveat in the first sentence, then the body-passing mechanics. Slightly cluttered by the truncated field list ('and 2 more fields'), but there is little waste.

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?

An output schema exists, so return-value detail isn't required, yet the description still notes JSON response materialization. Combined with the body-shape explanation and the safety-profile caveat, an agent has enough to invoke it correctly, though channel lifecycle behavior is not covered.

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%, so the baseline is 3. The description enumerates the Channel body fields (address, expiration, id, kind, params, payload, resourceId, resourceUri) but leaves '2 more fields' unspecified, and the params-vs-body_file guidance largely restates what the schema already says.

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+resource ('Watch for changes to Settings resources') and adds the HTTP method (POST) plus a critical behavioral note about read-only profiles. It also names the sibling operations over the same resource ('get, list'), so the agent can distinguish watch from those without opening the schema.

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 a clear when-not condition ('refused under --readonly safety profiles') and points to the sibling get/list operations for non-watch access. It does not, however, compare with the other watch-style tools in the fleet (calendar.events.watch, calendar.acl.watch) for selection.

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

Deploy Server

Other Tools