Skip to main content
Glama
Sign In

Playbook

by com.playbook
OverviewDiscussionsAdmin

Edit asset version comment

edit_asset_version_comment
DestructiveIdempotent

Edit the comment/note on an existing asset version, addressed by version_number. Requires a write-scope token and versioning enabled. Does NOT create a version and does NOT change the asset's bytes or head. Pass an empty string to clear the comment. Use list_asset_versions to find the version_number; an unknown or out-of-range number returns not found. Note the newest stored version is head_version_number − 1 (head_version_number is the next, not-yet-assigned number).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "token": "<token>",
      "version_number": "<version_number>",
      "comment": "<comment>"
    },
    "name": "edit_asset_version_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
tokenYesAsset token
commentYesNew comment text. Pass an empty string to clear it.
organizationNoWorkspace slug, as returned by list_organizations. Omit it when the account has a single workspace — it is then resolved from your token. Pass it only when the account has several, or when you mean a workspace other than the obvious one.
version_numberYesVersion whose comment to edit (from list_asset_versions)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / properties / version_number / anyOf
      Previous value: -[
-  {
-    "minimum": 1,
-    "type": "integer"
-  },
-  {
-    "pattern": "^\\s*\\d+\\s*$",
-    "type": "string"
-  }
-]New value: +[
+  {
+    "maximum": 9007199254740991,
+    "minimum": 1,
+    "type": "integer"
+  },
+  {
+    "pattern": "^\\s*\\d+\\s*$",
+    "type": "string"
+  }
+]
  2. Changed3 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / context
      Removed value: -{
-  "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "token",
-  "version_number",
-  "comment",
-  "context"
-]New value: +[
+  "token",
+  "version_number",
+  "comment"
+]
  3. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=true; the description adds real value on top by disclosing the auth scope, the versioning prerequisite, the clearing semantics of an empty string, and the not-found error for unknown/out-of-range versions. The remaining gap is that it never acknowledges that overwriting or clearing an existing comment is the destructive act flagged by destructiveHint — the prior comment text is lost irrecoverably, which the description only implies.

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 core action, then prerequisites, then exclusions and edge cases — a sensible order with almost no filler. The final sentence about `head_version_number` is dense and slightly confusing out of context, and it could be trimmed or tied more directly to how it affects choosing `version_number`.

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 four-parameter mutation with no output schema, the description covers prerequisites, error behavior, clearing semantics and the head-version offset — enough to call it correctly. The minor omission is what the call returns (e.g., the updated version object), which is not inferable since no output schema is supplied.

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

Parameters4/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, and the description earns above baseline by explaining that an empty `comment` clears the note and that `version_number` must come from `list_asset_versions`. The trailing note that the newest stored version is `head_version_number − 1` adds a non-obvious offset convention that the schema does not carry.

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 and resource ("Edit the comment/note on an existing asset version") and immediately scopes it by the `version_number` field. It is explicitly differentiated from its nearest siblings by ruling out version creation and byte/head mutation, so an agent can separate it from create_asset_version and update_asset without reading schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Names the prerequisite path (`list_asset_versions` to obtain `version_number`), the access requirement (write-scope token), and the environmental precondition (versioning enabled). It also gives explicit negative guidance — does not create a version, does not change bytes or head — and the when-to-use empty-string case for clearing.

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

All Playbook toolsInspect
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