Skip to main content
Glama

Change records in a version range

list_change_records
Read-onlyIdempotent

List the core change records (the human write-ups) that target a range of core versions, tagged by flavour and ranked, with counts. For the symbol-level diff, use what_changed. For one record in full, use get_change_record.

  • Bounds are inclusive. Forms: 11.2, 11.2.x, 11.2.0, 11, 11.x. A bare major covers every minor of it.

  • Flavours: coming-break (an API going away), coming-new-API (an API added), landed-but-still-relevant (already shipped). policy-only records target no version and never appear here.

  • project: one machine name. Each record then has the count of that project's development branches still on the legacy side.

  • Returns the count of every record in range plus a ranked head. Each entry has its nid for get_change_record.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toYesUpper core version bound, inclusive. Same forms as from.
fromYesLower core version bound, inclusive: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major (11) covers every minor of it.
limitNoRecords in the head, 1 to 40 (default 15). Above the cap the call is refused.
projectNoOptional contrib project machine name. Narrows the list to records a development branch of that project still matches.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / from / description
      Previous value: -"Lower core version bound, inclusive. Write it the way people say it: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major (11) covers every minor of it."New value: +"Lower core version bound, inclusive: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major (11) covers every minor of it."
    • changedInput schema / properties / limit / description
      Previous value: -"How many records to return in the head, 1 to 40 (default 15); above the cap the call is refused."New value: +"Records in the head, 1 to 40 (default 15). Above the cap the call is refused."
  2. Changed2 schema fields changed
    • changedInput schema / properties / from / description
      Previous value: -"Lower core version bound, inclusive. Write it the way people say it: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major starts at its first minor."New value: +"Lower core version bound, inclusive. Write it the way people say it: 11.2, 11.2.x, 11.2.0, 11, or 11.x. A bare major (11) covers every minor of it."
    • changedInput schema / properties / to / description
      Previous value: -"Upper core version bound, inclusive. Same forms as from. A bare major covers every minor of it."New value: +"Upper core version bound, inclusive. Same forms as from."
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "by_flavor": {
      -      "additionalProperties": {
      -        "type": "integer"
      -      },
      -      "type": "object"
      -    },
      -    "from": {
      -      "type": "string"
      -    },
      -    "project": {
      -      "type": "string"
      -    },
      -    "records": {
      -      "items": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "flavor": {
      -            "type": "string"
      -          },
      -          "nid": {
      -            "type": "integer"
      -          },
      -          "outstanding_branches": {
      -            "type": [
      -              "null",
      -              "integer"
      -            ]
      -          },
      -          "target_version": {
      -            "type": "string"
      -          },
      -          "title": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "nid",
      -          "title",
      -          "flavor",
      -          "target_version"
      -        ],
      -        "type": "object"
      -      },
      -      "type": [
      -        "null",
      -        "array"
      -      ]
      -    },
      -    "to": {
      -      "type": "string"
      -    },
      -    "total": {
      -      "type": "integer"
      -    },
      -    "truncated": {
      -      "type": "boolean"
      -    }
      -  },
      -  "required": [
      -    "from",
      -    "to",
      -    "total",
      -    "by_flavor",
      -    "records",
      -    "truncated"
      -  ],
      -  "type": "object"
      -}New value: +null
  4. Changed1 schema field changed
    • changedInput schema / properties / limit / description
      Previous value: -"How many records to return in the head. Defaults to 15, capped at 40."New value: +"How many records to return in the head, 1 to 40 (default 15); above the cap the call is refused."
  5. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already assert readOnly, idempotent, non-destructive behavior, and the description adds significant behavioral detail beyond that: inclusive bounds, supported version forms, flavour taxonomy, exclusion of policy-only records, and the return contract (count of all records plus a ranked head with nids). This is exactly the kind of context annotations alone cannot convey.

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 front-loaded with a one-sentence summary followed by compact bullet points. Each bullet earns its place: bounds, flavours, project behavior, and return shape. There is no repetition, filler, or vague language.

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?

With no output schema, the description supplies the essential return contract: count of every record, a ranked head, and each entry's nid for use with get_change_record. Combined with parameter semantics and explicit sibling routing, an agent has everything needed to invoke and interpret the tool correctly.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning by explaining version-form semantics, inclusive bounds, flavour values, and what the project parameter actually counts. The limit parameter is left to the schema, which already documents its default and cap.

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 first sentence names the exact operation and resource: 'List the core change records ... that target a range of core versions, tagged by flavour and ranked, with counts.' It also explicitly differentiates from what_changed (symbol-level diff) and get_change_record (single record in full), so an agent can disambiguate it from the sibling list without opening the schema.

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

Usage Guidelines5/5

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

The description explicitly routes to alternatives: 'For the symbol-level diff, use what_changed. For one record in full, use get_change_record.' It also clarifies which records never appear here (policy-only) and explains the narrowing effect of the project parameter, giving clear when-to-use and when-not-to-use guidance.

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