Skip to main content
Glama

Plan changed asset sync

plan_sync
Read-onlyIdempotent

Compare the versions in assets/spriteship/spriteship.lock.json with current SpriteShip state in one call. Returns unchanged/changed/unavailable per character, asset, map, or UI pack; exact animation frame-count/FPS/collision, revision, runtime-intent, map-shape and UI component summaries when the previous lock entry includes the snapshot returned by an earlier call; and explicit fetch/download/review-removal actions. Existing v1 lock files without snapshots still detect version changes, then upgrade by saving each returned snapshot. Requests may contain 100 entries; honor Retry-After if the weighted sync budget is reached. Never delete local files for an unavailable entity without user confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entitiesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / entities / items / properties / engine / description
      Previous value: -"Export engine already used by this lock entry. Defaults to phaser; tiled supports maps and UI pack artwork."New value: +"Export engine already used by this lock entry. Defaults to phaser; Sparrow XML supports characters; tiled supports maps and UI pack artwork."
    • changedInput schema / properties / entities / items / properties / engine / enum
      Previous value: -[
      -  "phaser",
      -  "godot",
      -  "unity",
      -  "gamemaker",
      -  "unreal",
      -  "tiled"
      -]New value: +[
      +  "phaser",
      +  "godot",
      +  "unity",
      +  "gamemaker",
      +  "fnf",
      +  "unreal",
      +  "tiled"
      +]
  2. Changed6 schema fields changed
    • addedInput schema / properties / entities / items / properties / artworkOnly
      Added value: +{
      +  "description": "UI pack only: preserve the originally authorized recovery mode; never silently enable it.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / entities / items / properties / componentIds
      Added value: +{
      +  "description": "UI pack only: preserve the original selected component IDs; omit for the whole pack.",
      +  "items": {
      +    "format": "uuid",
      +    "type": "string"
      +  },
      +  "maxItems": 256,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • changedInput schema / properties / entities / items / properties / engine / description
      Previous value: -"Export engine already used by this lock entry. Defaults to phaser; tiled is map-only."New value: +"Export engine already used by this lock entry. Defaults to phaser; tiled supports maps and UI pack artwork."
    • changedInput schema / properties / entities / items / properties / kind / enum
      Previous value: -[
      -  "character",
      -  "asset",
      -  "map"
      -]New value: +[
      +  "character",
      +  "asset",
      +  "map",
      +  "ui-pack"
      +]
    • changedInput schema / properties / entities / items / properties / snapshot / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "animations": {
      -        "additionalProperties": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "collisionBody": {
      -              "anyOf": [
      -                {
      -                  "anyOf": [
      -                    {
      -                      "additionalProperties": false,
      -                      "properties": {
      -                        "cx": {
      -                          "type": "number"
      -                        },
      -                        "cy": {
      -                          "type": "number"
      -                        },
      -                        "hh": {
      -                          "type": "number"
      -                        },
      -                        "hw": {
      -                          "type": "number"
      -                        },
      -                        "kind": {
      -                          "const": "rect",
      -                          "type": "string"
      -                        },
      -                        "rot": {
      -                          "type": "number"
      -                        }
      -                      },
      -                      "required": [
      -                        "kind",
      -                        "cx",
      -                        "cy",
      -                        "hw",
      -                        "hh"
      -                      ],
      -                      "type": "object"
      -                    },
      -                    {
      -                      "additionalProperties": false,
      -                      "properties": {
      -                        "cx": {
      -                          "type": "number"
      -                        },
      -                        "cy": {
      -                          "type": "number"
      -                        },
      -                        "kind": {
      -                          "const": "circle",
      -                          "type": "string"
      -                        },
      -                        "r": {
      -                          "type": "number"
      -                        }
      -                      },
      -                      "required": [
      -                        "kind",
      -                        "cx",
      -                        "cy",
      -                        "r"
      -                      ],
      -                      "type": "object"
      -                    },
      -                    {
      -                      "additionalProperties": false,
      -                      "properties": {
      -                        "kind": {
      -                          "const": "polygon",
      -                          "type": "string"
      -                        },
      -                        "points": {
      -                          "items": {
      -                            "additionalProperties": false,
      -                            "properties": {
      -                              "x": {
      -                                "type": "number"
      -                              },
      -                              "y": {
      -                                "type": "number"
      -                              }
      -                            },
      -                            "required": [
      -                              "x",
      -                              "y"
      -                            ],
      -                            "type": "object"
      -                          },
      -                          "maxItems": 64,
      -                          "minItems": 3,
      -                          "type": "array"
      -                        },
      -                        "rot": {
      -                          "type": "number"
      -                        }
      -                      },
      -                      "required": [
      -                        "kind",
      -                        "points"
      -                      ],
      -                      "type": "object"
      -                    }
      -                  ]
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            },
      -            "displayName": {
      -              "anyOf": [
      -                {
      -                  "maxLength": 200,
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            },
      -            "fps": {
      -              "minimum": 0,
      -              "type": "number"
      -            },
      -            "frameCount": {
      -              "minimum": 0,
      -              "type": "integer"
      -            },
      -            "loop": {
      -              "type": "boolean"
      -            }
      -          },
      -          "required": [
      -            "displayName",
      -            "frameCount",
      -            "fps",
      -            "loop",
      -            "collisionBody"
      -          ],
      -          "type": "object"
      -        },
      -        "propertyNames": {
      -          "maxLength": 200
      -        },
      -        "type": "object"
      -      },
      -      "collisionBody": {
      -        "anyOf": [
      -          {
      -            "anyOf": [
      -              {
      -                "additionalProperties": false,
      -                "properties": {
      -                  "cx": {
      -                    "type": "number"
      -                  },
      -                  "cy": {
      -                    "type": "number"
      -                  },
      -                  "hh": {
      -                    "type": "number"
      -                  },
      -                  "hw": {
      -                    "type": "number"
      -                  },
      -                  "kind": {
      -                    "const": "rect",
      -                    "type": "string"
      -                  },
      -                  "rot": {
      -                    "type": "number"
      -                  }
      -                },
      -                "required": [
      -                  "kind",
      -                  "cx",
      -                  "cy",
      -                  "hw",
      -                  "hh"
      -                ],
      -                "type": "object"
      -              },
      -              {
      -                "additionalProperties": false,
      -                "properties": {
      -                  "cx": {
      -                    "type": "number"
      -                  },
      -                  "cy": {
      -                    "type": "number"
      -                  },
      -                  "kind": {
      -                    "const": "circle",
      -                    "type": "string"
      -                  },
      -                  "r": {
      -                    "type": "number"
      -                  }
      -                },
      -                "required": [
      -                  "kind",
      -                  "cx",
      -                  "cy",
      -                  "r"
      -                ],
      -                "type": "object"
      -              },
      -              {
      -                "additionalProperties": false,
      -                "properties": {
      -                  "kind": {
      -                    "const": "polygon",
      -                    "type": "string"
      -                  },
      -                  "points": {
      -                    "items": {
      -                      "additionalProperties": false,
      -                      "properties": {
      -                        "x": {
      -                          "type": "number"
      -                        },
      -                        "y": {
      -                          "type": "number"
      -                        }
      -                      },
      -                      "required": [
      -                        "x",
      -                        "y"
      -                      ],
      -                      "type": "object"
      -                    },
      -                    "maxItems": 64,
      -                    "minItems": 3,
      -                    "type": "array"
      -                  },
      -                  "rot": {
      -                    "type": "number"
      -                  }
      -                },
      -                "required": [
      -                  "kind",
      -                  "points"
      -                ],
      -                "type": "object"
      -              }
      -            ]
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "frameSize": {
      -        "anyOf": [
      -          {
      -            "exclusiveMinimum": 0,
      -            "type": "integer"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "kind": {
      -        "const": "character",
      -        "type": "string"
      -      },
      -      "name": {
      -        "maxLength": 300,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "name",
      -      "frameSize",
      -      "collisionBody",
      -      "animations"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "animationPairs": {
      -        "additionalProperties": {
      -          "additionalProperties": false,
      -          "properties": {
      -            "fps": {
      -              "anyOf": [
      -                {
      -                  "minimum": 0,
      -                  "type": "number"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            },
      -            "frameCount": {
      -              "anyOf": [
      -                {
      -                  "minimum": 0,
      -                  "type": "integer"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            },
      -            "iterationCount": {
      -              "minimum": 0,
      -              "type": "integer"
      -            },
      -            "label": {
      -              "anyOf": [
      -                {
      -                  "maxLength": 300,
      -                  "type": "string"
      -                },
      -                {
      -                  "type": "null"
      -                }
      -              ]
      -            }
      -          },
      -          "required": [
      -            "label",
      -            "frameCount",
      -            "fps",
      -            "iterationCount"
      -          ],
      -          "type": "object"
      -        },
      -        "propertyNames": {
      -          "maxLength": 200
      -        },
      -        "type": "object"
      -      },
      -      "currentIterationId": {
      -        "anyOf": [
      -          {
      -            "maxLength": 300,
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "hasAnimation": {
      -        "type": "boolean"
      -      },
      -      "iterationCount": {
      -        "minimum": 0,
      -        "type": "integer"
      -      },
      -      "kind": {
      -        "const": "asset",
      -        "type": "string"
      -      },
      -      "name": {
      -        "maxLength": 300,
      -        "type": "string"
      -      },
      -      "runtimeUse": {
      -        "maxLength": 100,
      -        "type": "string"
      -      },
      -      "slug": {
      -        "anyOf": [
      -          {
      -            "maxLength": 200,
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "tileRuntimeUses": {
      -        "items": {
      -          "maxLength": 200,
      -          "type": "string"
      -        },
      -        "maxItems": 256,
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "name",
      -      "slug",
      -      "currentIterationId",
      -      "iterationCount",
      -      "hasAnimation",
      -      "runtimeUse",
      -      "tileRuntimeUses",
      -      "animationPairs"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "gridSize": {
      -        "exclusiveMinimum": 0,
      -        "type": "integer"
      -      },
      -      "hasMapData": {
      -        "type": "boolean"
      -      },
      -      "heightPx": {
      -        "exclusiveMinimum": 0,
      -        "type": "integer"
      -      },
      -      "kind": {
      -        "const": "map",
      -        "type": "string"
      -      },
      -      "name": {
      -        "maxLength": 300,
      -        "type": "string"
      -      },
      -      "widthPx": {
      -        "exclusiveMinimum": 0,
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "name",
      -      "widthPx",
      -      "heightPx",
      -      "gridSize",
      -      "hasMapData"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "animations": {
      +        "additionalProperties": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "collisionBody": {
      +              "anyOf": [
      +                {
      +                  "anyOf": [
      +                    {
      +                      "additionalProperties": false,
      +                      "properties": {
      +                        "cx": {
      +                          "type": "number"
      +                        },
      +                        "cy": {
      +                          "type": "number"
      +                        },
      +                        "hh": {
      +                          "type": "number"
      +                        },
      +                        "hw": {
      +                          "type": "number"
      +                        },
      +                        "kind": {
      +                          "const": "rect",
      +                          "type": "string"
      +                        },
      +                        "rot": {
      +                          "type": "number"
      +                        }
      +                      },
      +                      "required": [
      +                        "kind",
      +                        "cx",
      +                        "cy",
      +                        "hw",
      +                        "hh"
      +                      ],
      +                      "type": "object"
      +                    },
      +                    {
      +                      "additionalProperties": false,
      +                      "properties": {
      +                        "cx": {
      +                          "type": "number"
      +                        },
      +                        "cy": {
      +                          "type": "number"
      +                        },
      +                        "kind": {
      +                          "const": "circle",
      +                          "type": "string"
      +                        },
      +                        "r": {
      +                          "type": "number"
      +                        }
      +                      },
      +                      "required": [
      +                        "kind",
      +                        "cx",
      +                        "cy",
      +                        "r"
      +                      ],
      +                      "type": "object"
      +                    },
      +                    {
      +                      "additionalProperties": false,
      +                      "properties": {
      +                        "kind": {
      +                          "const": "polygon",
      +                          "type": "string"
      +                        },
      +                        "points": {
      +                          "items": {
      +                            "additionalProperties": false,
      +                            "properties": {
      +                              "x": {
      +                                "type": "number"
      +                              },
      +                              "y": {
      +                                "type": "number"
      +                              }
      +                            },
      +                            "required": [
      +                              "x",
      +                              "y"
      +                            ],
      +                            "type": "object"
      +                          },
      +                          "maxItems": 64,
      +                          "minItems": 3,
      +                          "type": "array"
      +                        },
      +                        "rot": {
      +                          "type": "number"
      +                        }
      +                      },
      +                      "required": [
      +                        "kind",
      +                        "points"
      +                      ],
      +                      "type": "object"
      +                    }
      +                  ]
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "displayName": {
      +              "anyOf": [
      +                {
      +                  "maxLength": 200,
      +                  "type": "string"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "fps": {
      +              "minimum": 0,
      +              "type": "number"
      +            },
      +            "frameCount": {
      +              "minimum": 0,
      +              "type": "integer"
      +            },
      +            "loop": {
      +              "type": "boolean"
      +            }
      +          },
      +          "required": [
      +            "displayName",
      +            "frameCount",
      +            "fps",
      +            "loop",
      +            "collisionBody"
      +          ],
      +          "type": "object"
      +        },
      +        "propertyNames": {
      +          "maxLength": 200
      +        },
      +        "type": "object"
      +      },
      +      "collisionBody": {
      +        "anyOf": [
      +          {
      +            "anyOf": [
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "cx": {
      +                    "type": "number"
      +                  },
      +                  "cy": {
      +                    "type": "number"
      +                  },
      +                  "hh": {
      +                    "type": "number"
      +                  },
      +                  "hw": {
      +                    "type": "number"
      +                  },
      +                  "kind": {
      +                    "const": "rect",
      +                    "type": "string"
      +                  },
      +                  "rot": {
      +                    "type": "number"
      +                  }
      +                },
      +                "required": [
      +                  "kind",
      +                  "cx",
      +                  "cy",
      +                  "hw",
      +                  "hh"
      +                ],
      +                "type": "object"
      +              },
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "cx": {
      +                    "type": "number"
      +                  },
      +                  "cy": {
      +                    "type": "number"
      +                  },
      +                  "kind": {
      +                    "const": "circle",
      +                    "type": "string"
      +                  },
      +                  "r": {
      +                    "type": "number"
      +                  }
      +                },
      +                "required": [
      +                  "kind",
      +                  "cx",
      +                  "cy",
      +                  "r"
      +                ],
      +                "type": "object"
      +              },
      +              {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "kind": {
      +                    "const": "polygon",
      +                    "type": "string"
      +                  },
      +                  "points": {
      +                    "items": {
      +                      "additionalProperties": false,
      +                      "properties": {
      +                        "x": {
      +                          "type": "number"
      +                        },
      +                        "y": {
      +                          "type": "number"
      +                        }
      +                      },
      +                      "required": [
      +                        "x",
      +                        "y"
      +                      ],
      +                      "type": "object"
      +                    },
      +                    "maxItems": 64,
      +                    "minItems": 3,
      +                    "type": "array"
      +                  },
      +                  "rot": {
      +                    "type": "number"
      +                  }
      +                },
      +                "required": [
      +                  "kind",
      +                  "points"
      +                ],
      +                "type": "object"
      +              }
      +            ]
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "frameSize": {
      +        "anyOf": [
      +          {
      +            "exclusiveMinimum": 0,
      +            "type": "integer"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "kind": {
      +        "const": "character",
      +        "type": "string"
      +      },
      +      "name": {
      +        "maxLength": 300,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name",
      +      "frameSize",
      +      "collisionBody",
      +      "animations"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "animationPairs": {
      +        "additionalProperties": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "fps": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "number"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "frameCount": {
      +              "anyOf": [
      +                {
      +                  "minimum": 0,
      +                  "type": "integer"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "iterationCount": {
      +              "minimum": 0,
      +              "type": "integer"
      +            },
      +            "label": {
      +              "anyOf": [
      +                {
      +                  "maxLength": 300,
      +                  "type": "string"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            }
      +          },
      +          "required": [
      +            "label",
      +            "frameCount",
      +            "fps",
      +            "iterationCount"
      +          ],
      +          "type": "object"
      +        },
      +        "propertyNames": {
      +          "maxLength": 200
      +        },
      +        "type": "object"
      +      },
      +      "currentIterationId": {
      +        "anyOf": [
      +          {
      +            "maxLength": 300,
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "hasAnimation": {
      +        "type": "boolean"
      +      },
      +      "iterationCount": {
      +        "minimum": 0,
      +        "type": "integer"
      +      },
      +      "kind": {
      +        "const": "asset",
      +        "type": "string"
      +      },
      +      "name": {
      +        "maxLength": 300,
      +        "type": "string"
      +      },
      +      "runtimeUse": {
      +        "maxLength": 100,
      +        "type": "string"
      +      },
      +      "slug": {
      +        "anyOf": [
      +          {
      +            "maxLength": 200,
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "tileRuntimeUses": {
      +        "items": {
      +          "maxLength": 200,
      +          "type": "string"
      +        },
      +        "maxItems": 256,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name",
      +      "slug",
      +      "currentIterationId",
      +      "iterationCount",
      +      "hasAnimation",
      +      "runtimeUse",
      +      "tileRuntimeUses",
      +      "animationPairs"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "gridSize": {
      +        "exclusiveMinimum": 0,
      +        "type": "integer"
      +      },
      +      "hasMapData": {
      +        "type": "boolean"
      +      },
      +      "heightPx": {
      +        "exclusiveMinimum": 0,
      +        "type": "integer"
      +      },
      +      "kind": {
      +        "const": "map",
      +        "type": "string"
      +      },
      +      "name": {
      +        "maxLength": 300,
      +        "type": "string"
      +      },
      +      "widthPx": {
      +        "exclusiveMinimum": 0,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name",
      +      "widthPx",
      +      "heightPx",
      +      "gridSize",
      +      "hasMapData"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "componentCount": {
      +        "minimum": 0,
      +        "type": "integer"
      +      },
      +      "components": {
      +        "additionalProperties": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "configurationHash": {
      +              "anyOf": [
      +                {
      +                  "maxLength": 300,
      +                  "type": "string"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "name": {
      +              "maxLength": 300,
      +              "type": "string"
      +            },
      +            "revisionId": {
      +              "anyOf": [
      +                {
      +                  "maxLength": 300,
      +                  "type": "string"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "status": {
      +              "maxLength": 200,
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "name",
      +            "revisionId",
      +            "configurationHash",
      +            "status"
      +          ],
      +          "type": "object"
      +        },
      +        "propertyNames": {
      +          "maxLength": 200
      +        },
      +        "type": "object"
      +      },
      +      "kind": {
      +        "const": "ui-pack",
      +        "type": "string"
      +      },
      +      "name": {
      +        "maxLength": 300,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name",
      +      "componentCount",
      +      "components"
      +    ],
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / entities / items / properties / version / description
      Previous value: -"contentVersion for a character; updatedAt for an asset or map."New value: +"contentVersion for a character or the exact UI pack export; updatedAt for an asset or map."
  3. Changed1 schema field changed
    • changedInput schema / properties / entities / items / properties / engine / enum
      Previous value: -[
      -  "phaser",
      -  "godot",
      -  "unity",
      -  "gamemaker",
      -  "tiled"
      -]New value: +[
      +  "phaser",
      +  "godot",
      +  "unity",
      +  "gamemaker",
      +  "unreal",
      +  "tiled"
      +]
  4. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint=false. The description adds substantial behavioral detail beyond that: it explains the conditional return of detailed summaries only when a snapshot is present, the upgrade path for v1 lock files, the explicit actions it plans (without executing them), and the safety constraint about local file deletion. It also discloses rate-limit handling via Retry-After, which is not implied by annotations.

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 dense but each sentence contributes meaning. It is front-loaded with the core purpose and then adds conditional behavior, upgrade notes, limits, and safety in a logical order. It is longer than typical, but the tool's complexity warrants the length. No redundancy or filler sentences.

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 complex planning tool with no output schema, the description covers the main return categories (unchanged/changed/unavailable, detailed summaries, actions), conditions for detailed summaries, legacy support, request limits, rate limiting, and safety. It doesn't describe the exact JSON response structure, but it lists the information types. Given the tool's complexity, this is a strong but not exhaustive coverage.

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?

The input schema itself contains descriptions for each property (id, kind, engine, version, snapshot, artworkOnly, componentIds), so the description doesn't need to repeat them. The description adds valuable semantics around the snapshot parameter: it clarifies that snapshots come from prior calls and enable richer summaries, and explains the v1 upgrade behavior. Since schema coverage is effectively complete, the description's additional guidance on when to provide snapshot and the limit of 100 entries justifies a high score.

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: 'Compare the versions in assets/spriteship/spriteship.lock.json with current SpriteShip state in one call.' It clearly distinguishes itself from individual getters and lists by being a bulk comparison that returns per-entity statuses. The mention of returning actions (fetch/download/review-removal) further clarifies its planning role.

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?

Provides clear context for when to use this tool: for checking changed entities and planning sync actions. It implicitly contrasts with individual get_* tools by being bulk and comparative. It also gives operational guidance: honor Retry-After, request limit of 100 entries, and the safety rule about not deleting without confirmation. It doesn't explicitly name alternatives but the context is sufficient for an agent to decide.

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