Skip to main content
Glama

script.projects.deployments.update

Update an Apps Script deployment's configuration, such as its version, description, or manifest, using a JSON UpdateDeploymentRequest. Blocked under read-only safety profiles.

Instructions

Updates a deployment of an Apps Script project [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON UpdateDeploymentRequest object accepting deploymentConfig; pass it via params or whole via body_file Siblings over the same resource: create, delete, 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.
scriptIdYes[URL path segment] The script project's Drive ID.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON UpdateDeploymentRequest object.
deploymentIdYes[URL path segment] The deployment ID for this deployment.
request_bodyNoRequest body of type UpdateDeploymentRequest: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
updateTimeNo
entryPointsNo
deploymentIdNo
deploymentConfigNo

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 UpdateDeploymentRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type UpdateDeploymentRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "deploymentConfig": {
      +      "properties": {
      +        "description": {
      +          "type": "string"
      +        },
      +        "manifestFileName": {
      +          "type": "string"
      +        },
      +        "scriptId": {
      +          "type": "string"
      +        },
      +        "versionNumber": {
      +          "type": "integer"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / deploymentId / description
      Previous value: -"The deployment ID for this deployment."New value: +"[URL path segment] The deployment ID for this deployment."
    • changedInput schema / properties / scriptId / description
      Previous value: -"The script project's Drive ID."New value: +"[URL path segment] The script project's Drive ID."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "deploymentConfig": {
      +      "properties": {
      +        "description": {
      +          "type": "string"
      +        },
      +        "manifestFileName": {
      +          "type": "string"
      +        },
      +        "scriptId": {
      +          "type": "string"
      +        },
      +        "versionNumber": {
      +          "type": "integer"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "deploymentId": {
      +      "type": "string"
      +    },
      +    "entryPoints": {
      +      "items": {
      +        "properties": {
      +          "addOn": {
      +            "properties": {
      +              "addOnType": {
      +                "enum": [
      +                  "UNKNOWN_ADDON_TYPE",
      +                  "GMAIL",
      +                  "DATA_STUDIO"
      +                ],
      +                "type": "string"
      +              },
      +              "description": {
      +                "type": "string"
      +              },
      +              "helpUrl": {
      +                "type": "string"
      +              },
      +              "postInstallTipUrl": {
      +                "type": "string"
      +              },
      +              "reportIssueUrl": {
      +                "type": "string"
      +              },
      +              "title": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "entryPointType": {
      +            "enum": [
      +              "ENTRY_POINT_TYPE_UNSPECIFIED",
      +              "WEB_APP",
      +              "EXECUTION_API",
      +              "ADD_ON"
      +            ],
      +            "type": "string"
      +          },
      +          "executionApi": {
      +            "properties": {
      +              "entryPointConfig": {
      +                "properties": {
      +                  "access": {
      +                    "enum": [
      +                      "UNKNOWN_ACCESS",
      +                      "MYSELF",
      +                      "DOMAIN",
      +                      "ANYONE",
      +                      "ANYONE_ANONYMOUS"
      +                    ],
      +                    "type": "string"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "webApp": {
      +            "properties": {
      +              "entryPointConfig": {
      +                "properties": {
      +                  "access": {
      +                    "enum": [
      +                      "UNKNOWN_ACCESS",
      +                      "MYSELF",
      +                      "DOMAIN",
      +                      "ANYONE",
      +                      "ANYONE_ANONYMOUS"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  "executeAs": {
      +                    "enum": [
      +                      "UNKNOWN_EXECUTE_AS",
      +                      "USER_ACCESSING",
      +                      "USER_DEPLOYING"
      +                    ],
      +                    "type": "string"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "url": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "updateTime": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description does real work: it declares the mutation, the HTTP PUT, the safety-profile refusal, and that the API's response resource is returned as JSON. It still omits auth/scope requirements and failure behavior for a bad scriptId/deploymentId, so it falls short of fully carrying the burden.

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

Conciseness5/5

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

One compact block with the verb and resource front-loaded, followed by method, safety caveat, body routing, and sibling list. No filler sentences; every clause carries information.

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, nested-body mutation with an output schema, the description covers method, mutation semantics, safety gating, payload routing, and sibling scope. What remains missing — auth requirements, deployment-existence precondition, error modes — is minor relative to the structured data already provided.

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 does clarify the routing choice for the update payload ('pass it via `params` or whole via `body_file`') and names UpdateDeploymentRequest/deploymentConfig, but that largely restates what the schema's own body_file and request_body descriptions already say.

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 (updates) plus the exact resource (a deployment of an Apps Script project) and pins the HTTP method (PUT). It also enumerates the sibling operations on the same resource (create, delete, get, list), though it does not say what distinguishes update from, say, create — that distinction is left to the reader.

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?

Usage is only implied: the write nature and the 'refused under --readonly safety profiles' note tell an agent this is a mutating call, but there is no explicit when-to-use versus the listed siblings, and no prerequisites (e.g. whether the deployment must already exist) are given.

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