Skip to main content
Glama

complete_review

DestructiveIdempotent

Transition a pending review request to the terminal completed or cancelled state. The artifact owner, requester, or assignee may perform the transition; it does not resolve threads, publish a version, or revoke reviewer access. Use completed only after reviewing the exact requested version.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
statusYesTerminal outcome: completed after review, or cancelled when no review is required.
requestIdYesID of an existing review request in the artifact.
documentIdYesID of the artifact containing the target resource.
idempotencyKeyYesStable unique key for this intended change; reuse only to retry the same inputs.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
statusYesCurrent review-request state.
createdAtYesISO 8601 timestamp.
versionIdYes
assigneeIdYes
documentIdYes
completedAtYes
completedByYes
requesterIdYes
instructionsYes
requesterNameYes
requesterTypeYes
completedByNameYes
completedOnBehalfOfIdYes
requesterOnBehalfOfIdYes
completedOnBehalfOfNameYes
requesterOnBehalfOfNameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / documentId / description
      Added value: +"ID of the artifact containing the target resource."
    • addedInput schema / properties / idempotencyKey / description
      Added value: +"Stable unique key for this intended change; reuse only to retry the same inputs."
    • addedInput schema / properties / requestId / description
      Added value: +"ID of an existing review request in the artifact."
    • addedInput schema / properties / status / description
      Added value: +"Terminal outcome: completed after review, or cancelled when no review is required."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "description": "Targeted review request for an immutable version.",
      +  "properties": {
      +    "assigneeId": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "completedAt": {
      +      "anyOf": [
      +        {
      +          "description": "ISO 8601 timestamp.",
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "completedBy": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "completedByName": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "completedOnBehalfOfId": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "completedOnBehalfOfName": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "createdAt": {
      +      "description": "ISO 8601 timestamp.",
      +      "type": "string"
      +    },
      +    "documentId": {
      +      "format": "uuid",
      +      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +      "type": "string"
      +    },
      +    "id": {
      +      "format": "uuid",
      +      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +      "type": "string"
      +    },
      +    "instructions": {
      +      "type": "string"
      +    },
      +    "requesterId": {
      +      "type": "string"
      +    },
      +    "requesterName": {
      +      "type": "string"
      +    },
      +    "requesterOnBehalfOfId": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "requesterOnBehalfOfName": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "requesterType": {
      +      "enum": [
      +        "human",
      +        "agent"
      +      ],
      +      "type": "string"
      +    },
      +    "status": {
      +      "description": "Current review-request state.",
      +      "enum": [
      +        "pending",
      +        "completed",
      +        "cancelled"
      +      ],
      +      "type": "string"
      +    },
      +    "versionId": {
      +      "format": "uuid",
      +      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "assigneeId",
      +    "completedAt",
      +    "completedBy",
      +    "completedByName",
      +    "completedOnBehalfOfId",
      +    "completedOnBehalfOfName",
      +    "createdAt",
      +    "documentId",
      +    "id",
      +    "instructions",
      +    "requesterId",
      +    "requesterName",
      +    "requesterOnBehalfOfId",
      +    "requesterOnBehalfOfName",
      +    "requesterType",
      +    "status",
      +    "versionId"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=true, idempotentHint=true), the description discloses role-based permissions, the requirement to review the exact requested version, and the terminal/irreversible nature of the state change. It also clearly states non-effects such as not resolving threads or revoking reviewer access.

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?

The description is three concise sentences with the primary purpose front-loaded. Every sentence adds value: state transition, permissions and exclusions, and usage guidance. No fluff or repetition.

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?

For a state-transition tool with 4 required parameters, a full output schema, and rich annotations, the description covers purpose, permissions, valid terminal states, and non-effects. It is sufficiently complete for an agent to select and invoke the tool correctly.

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 adds marginal context by tying 'completed' to reviewing the exact requested version, but most parameter meaning is already provided in the schema.

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?

The description clearly states the verb 'transition', the resource 'pending review request', and the terminal states 'completed or cancelled'. It also explicitly distinguishes itself from sibling tools by noting it does not resolve threads, publish a version, or revoke reviewer access.

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?

The description gives explicit conditions for when to use 'completed' versus 'cancelled', names the permitted actors (artifact owner, requester, assignee), and lists what the tool does not do. It does not name sibling alternatives explicitly, but the context is sufficient to guide selection among related tools like publish_version and request_review.

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.

Resources