Skip to main content
Glama

Get tool execution

get_tool_execution
Read-onlyIdempotent

Return a tool execution snapshot with status, progress, attemptIndex, error details, and results. Each result includes fileId, file metadata, downloadUrl, and thumbnailUrl when available. Use this to poll a started generation without creating another asset.

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": {
      "toolExecutionId": "<toolExecutionId>"
    },
    "name": "get_tool_execution"
  }
}

Input Schema

NameRequiredDescriptionDefault
toolExecutionIdYesExecution to inspect or cancel. Use toolExecutionId from a media-tool start result or list_tool_executions.

Output Schema

NameRequiredDescriptionDefault
errorYesError details when status is failed; otherwise null.
statusYesJob status: pending, running, succeeded, failed, or cancelled.
resultsYesGenerated results; empty until succeeded.
toolTypeYesTool name (e.g. GENERATE_IMAGE).
attemptIndexYesCurrent or latest attempt index.
toolExecutionIdYesTool execution id (vg_tool_...).
progressPercentageYesCompletion progress 0-100.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed33 schema fields changed
    • changedOutput schema / properties / error / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": {},
      -    "properties": {
      -      "code": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Machine-readable error code."
      -      },
      -      "internalErrorCode": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Opaque code for support."
      -      },
      -      "message": {
      -        "description": "Human-readable error description.",
      -        "type": "string"
      -      },
      -      "requirement": {
      -        "anyOf": [
      -          {
      -            "additionalProperties": {},
      -            "properties": {
      -              "details": {
      -                "additionalProperties": {
      -                  "type": "string"
      -                },
      -                "propertyNames": {
      -                  "type": "string"
      -                },
      -                "type": "object"
      -              },
      -              "type": {
      -                "description": "Requirement type (e.g. purchase_add_on).",
      -                "type": "string"
      -              }
      -            },
      -            "required": [
      -              "type"
      -            ],
      -            "type": "object"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "What is needed to resolve the error, when applicable."
      -      }
      -    },
      -    "required": [
      -      "message"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": {},
      +    "properties": {
      +      "code": {
      +        "description": "Machine-readable error code.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "internalErrorCode": {
      +        "description": "Opaque code for support.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "message": {
      +        "description": "Human-readable error description.",
      +        "type": "string"
      +      },
      +      "requirement": {
      +        "anyOf": [
      +          {
      +            "additionalProperties": {},
      +            "properties": {
      +              "details": {
      +                "additionalProperties": {
      +                  "type": "string"
      +                },
      +                "propertyNames": {
      +                  "type": "string"
      +                },
      +                "type": "object"
      +              },
      +              "type": {
      +                "description": "Requirement type (e.g. purchase_add_on).",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "type"
      +            ],
      +            "type": "object"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "description": "What is needed to resolve the error, when applicable."
      +      }
      +    },
      +    "required": [
      +      "message"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / results / items / properties / downloadUrl / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / downloadUrl / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / downloadUrlExpiresAt / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / downloadUrlExpiresAt / type
      Added value: +[
      +  "number",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / description / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / description / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / results / items / properties / file / properties / downloadSource / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": {},
      -    "description": "A file rendition source (thumbnail, preview, download, …).",
      -    "properties": {
      -      "expiresAt": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Unix expiry for url."
      -      },
      -      "fileBytes": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition size in bytes."
      -      },
      -      "height": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition height in pixels."
      -      },
      -      "status": {
      -        "description": "Rendition status.",
      -        "enum": [
      -          "pending",
      -          "ready",
      -          "failed",
      -          "skipped"
      -        ],
      -        "type": "string"
      -      },
      -      "url": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Signed URL when status is ready."
      -      },
      -      "width": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition width in pixels."
      -      }
      -    },
      -    "required": [
      -      "status"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": {},
      +    "description": "A file rendition source (thumbnail, preview, download, …).",
      +    "properties": {
      +      "expiresAt": {
      +        "description": "Unix expiry for url.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "fileBytes": {
      +        "description": "Rendition size in bytes.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "height": {
      +        "description": "Rendition height in pixels.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "status": {
      +        "description": "Rendition status.",
      +        "enum": [
      +          "pending",
      +          "ready",
      +          "failed",
      +          "skipped"
      +        ],
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "Signed URL when status is ready.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "width": {
      +        "description": "Rendition width in pixels.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "status"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / downloadUrl / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / downloadUrl / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / downloadUrlExpiresAt / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / downloadUrlExpiresAt / type
      Added value: +[
      +  "number",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / durationSeconds / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / durationSeconds / type
      Added value: +[
      +  "number",
      +  "null"
      +]
    • changedOutput schema / properties / results / items / properties / file / properties / hlsSource / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": {},
      -    "description": "A file rendition source (thumbnail, preview, download, …).",
      -    "properties": {
      -      "expiresAt": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Unix expiry for url."
      -      },
      -      "fileBytes": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition size in bytes."
      -      },
      -      "height": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition height in pixels."
      -      },
      -      "status": {
      -        "description": "Rendition status.",
      -        "enum": [
      -          "pending",
      -          "ready",
      -          "failed",
      -          "skipped"
      -        ],
      -        "type": "string"
      -      },
      -      "url": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Signed URL when status is ready."
      -      },
      -      "width": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition width in pixels."
      -      }
      -    },
      -    "required": [
      -      "status"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": {},
      +    "description": "A file rendition source (thumbnail, preview, download, …).",
      +    "properties": {
      +      "expiresAt": {
      +        "description": "Unix expiry for url.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "fileBytes": {
      +        "description": "Rendition size in bytes.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "height": {
      +        "description": "Rendition height in pixels.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "status": {
      +        "description": "Rendition status.",
      +        "enum": [
      +          "pending",
      +          "ready",
      +          "failed",
      +          "skipped"
      +        ],
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "Signed URL when status is ready.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "width": {
      +        "description": "Rendition width in pixels.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "status"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / results / items / properties / file / properties / previewSource / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": {},
      -    "description": "A file rendition source (thumbnail, preview, download, …).",
      -    "properties": {
      -      "expiresAt": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Unix expiry for url."
      -      },
      -      "fileBytes": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition size in bytes."
      -      },
      -      "height": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition height in pixels."
      -      },
      -      "status": {
      -        "description": "Rendition status.",
      -        "enum": [
      -          "pending",
      -          "ready",
      -          "failed",
      -          "skipped"
      -        ],
      -        "type": "string"
      -      },
      -      "url": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Signed URL when status is ready."
      -      },
      -      "width": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition width in pixels."
      -      }
      -    },
      -    "required": [
      -      "status"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": {},
      +    "description": "A file rendition source (thumbnail, preview, download, …).",
      +    "properties": {
      +      "expiresAt": {
      +        "description": "Unix expiry for url.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "fileBytes": {
      +        "description": "Rendition size in bytes.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "height": {
      +        "description": "Rendition height in pixels.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "status": {
      +        "description": "Rendition status.",
      +        "enum": [
      +          "pending",
      +          "ready",
      +          "failed",
      +          "skipped"
      +        ],
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "Signed URL when status is ready.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "width": {
      +        "description": "Rendition width in pixels.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "status"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / publicHlsUrl / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / publicHlsUrl / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / publicPlaybackId / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / publicPlaybackId / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / results / items / properties / file / properties / thumbnailSource / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": {},
      -    "description": "A file rendition source (thumbnail, preview, download, …).",
      -    "properties": {
      -      "expiresAt": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Unix expiry for url."
      -      },
      -      "fileBytes": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition size in bytes."
      -      },
      -      "height": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition height in pixels."
      -      },
      -      "status": {
      -        "description": "Rendition status.",
      -        "enum": [
      -          "pending",
      -          "ready",
      -          "failed",
      -          "skipped"
      -        ],
      -        "type": "string"
      -      },
      -      "url": {
      -        "anyOf": [
      -          {
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Signed URL when status is ready."
      -      },
      -      "width": {
      -        "anyOf": [
      -          {
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Rendition width in pixels."
      -      }
      -    },
      -    "required": [
      -      "status"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": {},
      +    "description": "A file rendition source (thumbnail, preview, download, …).",
      +    "properties": {
      +      "expiresAt": {
      +        "description": "Unix expiry for url.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "fileBytes": {
      +        "description": "Rendition size in bytes.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "height": {
      +        "description": "Rendition height in pixels.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "status": {
      +        "description": "Rendition status.",
      +        "enum": [
      +          "pending",
      +          "ready",
      +          "failed",
      +          "skipped"
      +        ],
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "Signed URL when status is ready.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "width": {
      +        "description": "Rendition width in pixels.",
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "status"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / thumbnailUrl / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / thumbnailUrl / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / thumbnailUrlExpiresAt / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / thumbnailUrlExpiresAt / type
      Added value: +[
      +  "number",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / transcriptText / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / transcriptText / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / file / properties / type / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / file / properties / type / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / thumbnailUrl / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / thumbnailUrl / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / results / items / properties / thumbnailUrlExpiresAt / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / results / items / properties / thumbnailUrlExpiresAt / type
      Added value: +[
      +  "number",
      +  "null"
      +]
  2. Changed5 schema fields changed
    • changedInput schema / properties / toolExecutionId / description
      Previous value: -"Tool execution id (vg_tool_...)."New value: +"Execution to inspect or cancel. Use toolExecutionId from a media-tool start result or list_tool_executions."
    • changedOutput schema / description
      Previous value: -"Tool execution id, or full execution status after waiting (results when succeeded)."New value: +"Full tool-execution status snapshot."
    • changedOutput schema / properties / progressPercentage / description
      Previous value: -"Completion progress 0-100 (present after polling)."New value: +"Completion progress 0-100."
    • changedOutput schema / properties / results / description
      Previous value: -"Generated results with download URLs when succeeded."New value: +"Generated results; empty until succeeded."
    • changedOutput schema / required
      Previous value: -[
      -  "toolExecutionId"
      -]New value: +[
      +  "toolExecutionId",
      +  "status",
      +  "toolType",
      +  "progressPercentage",
      +  "attemptIndex",
      +  "results",
      +  "error"
      +]
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description still adds meaningful context beyond them by framing the call as a repeatable poll that does not create new assets, and by disclosing that error details and per-attempt progress are part of the payload. It does not mention rate limits or terminal-state behavior, keeping it out of 5 territory.

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?

Three short sentences: what is returned, what each result contains, and why to call it. Purpose and usage are front-loaded, and no sentence is filler.

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?

An output schema exists, so the description does not need to enumerate return fields, yet it still gives enough shape (status, progress, results, download URLs) for an agent to know what it will get. Combined with rich annotations and a fully documented single parameter, only the missing explicit alternative (list_tool_executions) keeps it from a 5.

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?

With a single parameter at 100% schema description coverage, the schema already explains toolExecutionId and even where to source it (a start result or list_tool_executions). The description adds no further meaning about the identifier, so the baseline of 3 applies.

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 names a specific resource (a tool execution snapshot) and enumerates what it carries: status, progress, attemptIndex, error details, and results. That is far more concrete than a restated title. It does not explicitly contrast itself with the sibling list_tool_executions, so it stops short of a 5.

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?

'Use this to poll a started generation without creating another asset' gives a clear when-to-use condition tied to polling after a start call. The input schema additionally hints at the cancel path via cancelToolExecution/cancel_tool_execution, but the description itself never names an alternative tool or an exclusion, so it is context rather than explicit routing.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.