Skip to main content
Glama

Get Migration Notes

get_migration_notes
Read-onlyIdempotent

Get upgrade notes between RevoGrid versions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
frameworkNo
toVersionYes
fromVersionYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
frameworkNo
toVersionYes
fromVersionYes
packageChangesYes
renamedSymbolsYes
breakingChangesYes
changedDefaultsYes
recommendedDocsYes
recommendedExamplesYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed3 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "additionalProperties": false,
      +  "properties": {
      +    "breakingChanges": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "changedDefaults": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "framework": {
      +      "enum": [
      +        "react",
      +        "vue",
      +        "angular",
      +        "svelte",
      +        "vanilla"
      +      ],
      +      "type": "string"
      +    },
      +    "fromVersion": {
      +      "type": "string"
      +    },
      +    "packageChanges": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "recommendedDocs": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "authority": {
      +            "type": "number"
      +          },
      +          "docType": {
      +            "enum": [
      +              "guide",
      +              "api",
      +              "example",
      +              "live-demo",
      +              "migration",
      +              "faq"
      +            ],
      +            "type": "string"
      +          },
      +          "exampleUrl": {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          "framework": {
      +            "enum": [
      +              "react",
      +              "vue",
      +              "angular",
      +              "svelte",
      +              "vanilla"
      +            ],
      +            "type": "string"
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "packageName": {
      +            "type": "string"
      +          },
      +          "packageVersion": {
      +            "type": "string"
      +          },
      +          "product": {
      +            "enum": [
      +              "core",
      +              "pro",
      +              "pivot",
      +              "gantt",
      +              "scheduler",
      +              "kanban",
      +              "collaboration",
      +              "enterprise"
      +            ],
      +            "type": "string"
      +          },
      +          "requiresPro": {
      +            "type": "boolean"
      +          },
      +          "score": {
      +            "type": "number"
      +          },
      +          "snippet": {
      +            "type": "string"
      +          },
      +          "sourcePath": {
      +            "type": "string"
      +          },
      +          "sourceRevision": {
      +            "type": "string"
      +          },
      +          "summary": {
      +            "type": "string"
      +          },
      +          "surface": {
      +            "enum": [
      +              "core",
      +              "pro",
      +              "pivot",
      +              "plugin",
      +              "columntype",
      +              "migration",
      +              "changelog",
      +              "internal"
      +            ],
      +            "type": "string"
      +          },
      +          "symbolKind": {
      +            "enum": [
      +              "class",
      +              "function",
      +              "interface",
      +              "type",
      +              "enum",
      +              "variable",
      +              "event",
      +              "plugin",
      +              "component",
      +              "unknown"
      +            ],
      +            "type": "string"
      +          },
      +          "symbols": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "title": {
      +            "type": "string"
      +          },
      +          "url": {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          "version": {
      +            "type": "string"
      +          },
      +          "visibility": {
      +            "enum": [
      +              "public",
      +              "internal"
      +            ],
      +            "type": "string"
      +          },
      +          "whyMatched": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "title",
      +          "summary",
      +          "surface",
      +          "docType",
      +          "requiresPro",
      +          "symbols",
      +          "score",
      +          "snippet",
      +          "url"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "recommendedExamples": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "exampleUrl": {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          "framework": {
      +            "enum": [
      +              "react",
      +              "vue",
      +              "angular",
      +              "svelte",
      +              "vanilla"
      +            ],
      +            "type": "string"
      +          },
      +          "id": {
      +            "type": "string"
      +          },
      +          "packages": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "requiresPro": {
      +            "type": "boolean"
      +          },
      +          "score": {
      +            "type": "number"
      +          },
      +          "sourceUrl": {
      +            "type": "string"
      +          },
      +          "summary": {
      +            "type": "string"
      +          },
      +          "surface": {
      +            "enum": [
      +              "core",
      +              "pro",
      +              "pivot",
      +              "plugin",
      +              "columntype",
      +              "migration",
      +              "changelog",
      +              "internal"
      +            ],
      +            "type": "string"
      +          },
      +          "title": {
      +            "type": "string"
      +          },
      +          "version": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id",
      +          "title",
      +          "surface",
      +          "requiresPro",
      +          "summary",
      +          "packages",
      +          "score"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "renamedSymbols": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "from": {
      +            "type": "string"
      +          },
      +          "to": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "from",
      +          "to"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "toVersion": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "fromVersion",
      +    "toVersion",
      +    "breakingChanges",
      +    "renamedSymbols",
      +    "changedDefaults",
      +    "packageChanges",
      +    "recommendedDocs",
      +    "recommendedExamples"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is well covered. The description adds no extra behavioral context beyond the basic lookup action, but it does not contradict the annotations.

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 a single, front-loaded sentence with no filler. Every word contributes to the core purpose, and it is appropriately sized for a simple lookup tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

While annotations and output schema cover safety and return structure, the description is missing key context such as what version formats are accepted, the role of the framework parameter, and when to prefer this tool over sibling doc/example tools. It is minimally adequate but not fully complete.

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

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, and the description only loosely maps to fromVersion/toVersion by saying 'between RevoGrid versions.' It does not explain version format expectations, nor does it clarify the optional 'framework' parameter's meaning or filtering role, leaving a significant gap.

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 uses a specific verb ('Get') and resource ('upgrade notes between RevoGrid versions') that clearly identify the tool's function. It is distinct from siblings like find_examples or search_revogrid_docs, though it does not explicitly differentiate itself.

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

Usage Guidelines2/5

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

The description provides no guidance about when to use this tool versus alternatives such as search_revogrid_docs or validate_revogrid_usage. There are no stated conditions, exclusions, or prerequisites, leaving the agent to infer appropriate use from the name alone.

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.

TDQS

A4/5.0
Disambiguation4/5

Each tool targets a distinct stage in the RevoGrid workflow: capability discovery, exact API inspection, broad documentation search, feature-matrix lookup, examples, migration notes, planning, and validation. The discovery-oriented tools overlap somewhat in surface area, but their descriptions clearly separate broad search, exact symbol resolution, and feature-existence checks.

Naming Consistency5/5

All eight tool names follow a consistent lowercase snake_case verb_noun pattern, such as find_examples, list_revogrid_capabilities, and validate_revogrid_usage. While some names omit the 'revogrid' prefix, the imperative verb + object structure is predictable and uniform.

Tool Count5/5

Eight tools is a well-scoped size for a RevoGrid implementation assistant. Each tool maps to a distinct need from discovery through planning and validation, with no redundant or filler tools.

Completeness5/5

The server covers the full advisory lifecycle: discover capabilities, search documentation, resolve feature existence, inspect exact APIs, find examples, plan implementations, validate usage, and check migration notes. There are no obvious gaps or dead ends for the stated RevoGrid-focused purpose.