Skip to main content
Glama

tasks.tasklists.patch

Updates specified fields of an authenticated user's task list via PATCH and returns the updated resource as JSON.

Instructions

Updates the authenticated user's specified task list. This method supports patch semantics [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON TaskList object accepting etag, id, kind, selfLink, title, updated; pass it via params or whole via body_file Siblings over the same resource: delete, get, insert, list, update.

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.
tasklistYes[URL path segment] Task list identifier.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON TaskList object.
request_bodyNoRequest body of type TaskList: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
idNo
etagNo
kindNo
titleNo
updatedNo
selfLinkNo

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 TaskList object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type TaskList: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "etag": {
      +      "type": "string"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "kind": {
      +      "type": "string"
      +    },
      +    "selfLink": {
      +      "type": "string"
      +    },
      +    "title": {
      +      "type": "string"
      +    },
      +    "updated": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed2 schema fields changed
    • changedInput schema / properties / tasklist / description
      Previous value: -"Task list identifier."New value: +"[URL path segment] Task list identifier."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "etag": {
      +      "type": "string"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "kind": {
      +      "type": "string"
      +    },
      +    "selfLink": {
      +      "type": "string"
      +    },
      +    "title": {
      +      "type": "string"
      +    },
      +    "updated": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A4/5.0
Behavior4/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 a reasonable job: it discloses mutation via HTTP PATCH, the readonly-profile refusal, and the response shape. It omits auth/scope requirements and does not say what happens to fields not included in the patch body, which is the key behavioral question for a PATCH.

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 semantics, safety, return shape, and siblings in a compact run. The em-dash-chained clauses are dense but every sentence carries information; nothing is padding.

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

Completeness5/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 values need not be explained, parameters are fully described in the schema, and the description covers mutation semantics, safety-profile behavior, and sibling routing. For a single-resource PATCH tool, an agent has what it needs to call it correctly.

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 description coverage is 100%, so the baseline is 3. The description's mention of the TaskList body fields and of passing via `params` or `body_file` largely restates what the schema already documents, adding little semantic weight beyond the schema.

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 ('Updates the authenticated user's specified task list') and names the sibling set over the same resource, so an agent can place it among delete/get/insert/list/update. It stops short of explicitly contrasting patch semantics with the `update` sibling's full-replace behavior, which is the one distinction that matters most here.

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?

The 'refused under --readonly safety profiles' clause is an explicit when-not condition, and the sibling list gives the agent an alternative set to choose from. However, no condition is given for selecting patch over update, so the routing signal is present but not fully resolved.

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