Skip to main content
Glama

Update a custom script

action1_update_script
Destructive

Modify an existing custom script by ID to update parameters, language, script text, or reboot exit codes, with dry-run preview and confirmed execution.

Instructions

Update a custom script. Updates details for an existing custom script specified by its ID. Perm: manage_scripts.

Input Schema

NameRequiredDescriptionDefault
bodyNoRequest body
confirmNoRequired to execute. Exact string "YES".
dry_runNoDefault true (preview). Set false to execute.
script_idYesProvide a specific script ID.

Output Schema

NameRequiredDescriptionDefault
idNo
nameNo
selfNo
toolNo
typeNo
paramsNo
statusNo
builtinNo
dry_runNo
languageNo
would_sendNo
descriptionNo
script_textNo
enterprise_idNo
success_codesNo
reboot_exit_codesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed21 schema fields changedv0.6.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedInput schema / properties / body / description
      Previous value: -"Request body (schema: object)"New value: +"Request body"
    • addedInput schema / properties / body / properties
      Added value: +{
      +  "description": {
      +    "description": "The script description.",
      +    "type": "string"
      +  },
      +  "language": {
      +    "description": "The scripting language.",
      +    "enum": [
      +      "PowerShell",
      +      "Command",
      +      "Bash"
      +    ],
      +    "type": "string"
      +  },
      +  "name": {
      +    "description": "The script name.",
      +    "type": "string"
      +  },
      +  "params": {
      +    "items": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "default": {
      +          "description": "Uses this value, unless a different value is specified.",
      +          "type": "string"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "type": {
      +          "enum": [
      +            "String",
      +            "Int",
      +            "Float",
      +            "DateTimeString"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  "reboot_exit_codes": {
      +    "description": "The exit codes that indicate a reboot is required.",
      +    "type": "string"
      +  },
      +  "script_text": {
      +    "description": "The script text.",
      +    "type": "string"
      +  }
      +}
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / additionalProperties
      Previous value: -trueNew value: +{}
    • addedOutput schema / properties / builtin
      Added value: +{}
    • addedOutput schema / properties / description
      Added value: +{}
    • addedOutput schema / properties / dry_run
      Added value: +{}
    • addedOutput schema / properties / enterprise_id
      Added value: +{}
    • addedOutput schema / properties / id
      Added value: +{}
    • addedOutput schema / properties / language
      Added value: +{}
    • addedOutput schema / properties / name
      Added value: +{}
    • addedOutput schema / properties / params
      Added value: +{}
    • addedOutput schema / properties / reboot_exit_codes
      Added value: +{}
    • addedOutput schema / properties / script_text
      Added value: +{}
    • addedOutput schema / properties / self
      Added value: +{}
    • addedOutput schema / properties / status
      Added value: +{}
    • addedOutput schema / properties / success_codes
      Added value: +{}
    • addedOutput schema / properties / tool
      Added value: +{}
    • addedOutput schema / properties / type
      Added value: +{}
    • addedOutput schema / properties / would_send
      Added value: +{}
  2. First observedv0.5.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already disclose destructive, non-idempotent, and open-world behavior. The description adds useful authorization context with 'Perm: manage_scripts', though it does not further explain mutation behavior beyond what the schema and annotations provide.

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 short and front-loaded, but the first sentence largely repeats the title and the second sentence restates the update purpose. It is efficient overall, with only minor redundancy.

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?

The tool has rich schema coverage, annotations, and an output schema, so the description does not need to explain return values or parameters. However, for a destructive update tool it gives no guidance on preview/execute behavior or sibling alternatives, leaving some contextual gaps.

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 schema already documents script_id, body fields, confirm, and dry_run. The description only reiterates that the script is specified by ID and adds no additional parameter semantics 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?

The description states a specific verb and resource: update an existing custom script by ID. It is clear what the tool does, but it does not distinguish this from sibling script tools such as create_script, delete_script, or update_version.

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?

The phrase 'existing custom script specified by its ID' implies when to use the tool, but there is no explicit guidance on alternatives, when not to use it, or how dry_run/confirm affect invocation. Usage context is only implied.

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