Skip to main content
Glama

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).

Input Schema

TableJSON 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. 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"
+]
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnly=false, idempotent=true, destructive=true) by disclosing the required scope, the versioning-enabled precondition, the exact blast radius (does not change bytes or head), the clear-with-empty-string behavior, and the not-found error for unknown/out-of-range versions.

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 and address key, then preconditions, then the side-effect exclusions. Every sentence carries information, though the trailing head_version_number arithmetic adds density that could be split or trimmed.

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?

No output schema exists, yet the description covers auth scope, preconditions, side effects, edge cases (empty string, unknown version), and failure mode. Nothing needed to invoke it correctly is missing.

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, but the description adds genuinely non-obvious meaning: empty string clears the comment, and the newest stored version is `head_version_number − 1` rather than the head value itself. That resolves a real ambiguity an agent would otherwise hit.

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 ('Edit the comment/note on an existing asset version') and pins the addressing key (`version_number`). It also explicitly differentiates from the nearest siblings by declaring it does NOT create a version, which separates it from create_asset_version.

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 prerequisite path ('Use `list_asset_versions` to find the `version_number`') and states the conditions required (write-scope token, versioning enabled). It does not name the alternative tool to use when you actually want a new version, so it stops short of full when/when-not routing.

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