Skip to main content
Glama

Get release notes

get_release_notes
Read-onlyIdempotent

Get release notes. Use this when the user asks what changed between two versions of a package, or what to watch for in an upgrade, such as "what changed in express between 4.18.2 and 5.1.0?" or "are there breaking changes from requests 2.28 to 2.32?". Pass the npm or PyPI package name (or a GitHub repo) and fromVersion, the version the user has; toVersion defaults to the latest release. Returns each release after fromVersion up to toVersion, newest first, with its date, link, a short excerpt of its notes and a breaking flag, plus a GitHub compare link. Notes come from GitHub releases and, when those do not reach back far enough, from the repository's changelog file; complete is false when neither covers the whole range. Not for vulnerabilities.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoPublic package name, such as "express" or "requests". Its latest release names the GitHub repository.
repoNoA GitHub repository instead of, or with, a package name: "owner/repo" or its github.com url
ecosystemNonpm (the default) or pypi; used with name
toVersionNoThe version to upgrade to; the package's latest release when left out
fromVersionYesThe version you have now, such as 4.18.2. Notes start after it.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
asOfYes
nameNo
errorNo
noticeYes
sourceYes
statusYes
completeNoFalse when the newest 10 GitHub releases and the changelog do not reach back to fromVersion
releasesNoReleases after fromVersion up to toVersion, newest first
ecosystemNo
toVersionNo
compareUrlNo
repositoryNo
fromVersionYes
changelogUrlNo
releaseCountNo
omittedVersionsNoOlder releases in the range left out to keep the answer short
breakingVersionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added
  2. Removed
  3. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/openWorld/non-destructive, so the description's job is to add what they cannot. It does: result ordering (newest first), the fields returned (date, link, excerpt, breaking flag, compare link), the two data sources (GitHub releases, then changelog fallback), and the meaning of the 'complete' flag when sources don't span the range.

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?

Front-loaded with purpose and examples before mechanics, and every sentence carries signal (sources, fallback, completeness flag). It is dense and runs long for a single paragraph, but there is little that could be cut without losing routing or output context.

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 an output schema present, the description needn't explain returns, yet it still describes ordering, fields, fallback sources, and the completeness caveat. For a 5-param, read-only lookup with a clear default and an explicit exclusion, nothing an agent needs to call it correctly is missing.

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: name is an npm/PyPI package whose latest release names the GitHub repo, repo is an alternative or complement to name, toVersion defaults to latest, and notes start after fromVersion. Defaults and inter-parameter relationships go beyond the field-level schema text.

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+resource ('Get release notes') and immediately scopes it with two concrete user-question examples, so an agent recognizes the intent instantly. It also excludes a nearby-but-wrong use case ('Not for vulnerabilities'), which cleanly separates it from siblings like check_license or get_eol_status.

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?

Gives explicit when-to-use triggers ('what changed between two versions', 'what to watch for in an upgrade'), worked query phrasings, and an explicit when-not ('Not for vulnerabilities'). Required vs optional inputs are framed (fromVersion is what the user has; toVersion defaults to latest).

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.