Skip to main content
Glama

whats_new

Compare two indexed documentation versions to identify added, removed, and changed pages, helping plan upgrades and review release differences.

Instructions

Docs pages added / removed / changed between two indexed versions (upgrade planning).

Args:
    project: project id.
    old_version: older version (default: the release before new_version).
    new_version: newer version (default: latest release). Use 'next' / 'main' for unreleased docs.
    limit: max pages listed per category.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project": "<project>"
    },
    "name": "whats_new"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
projectYes
new_versionNo
old_versionNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior3/5

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

No annotations are supplied, so the description must carry the behavioral burden. It usefully explains default version resolution, special 'next'/'main' values, and that limit applies per category, but it omits read-only status, error behavior, and any indexing prerequisites beyond the phrase 'indexed versions'.

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 purpose is front-loaded in one sentence, followed by a compact Args block. Given the 0% schema description coverage, each parameter line earns its place and there is no filler.

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 four-parameter diff tool with an output schema, the definition covers the required project, optional version defaults, special version tokens, and per-category limit behavior. It leaves discovery of valid project/version IDs and error handling implicit.

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 description coverage is 0%, and the description compensates by explaining all four parameters: project as project id, old_version defaulting to the release before new_version, new_version defaulting to the latest release, and limit as max pages per category. It adds meaningful semantics but leaves version and project ID formats unspecified.

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 states a specific operation: docs pages added, removed, or changed between two indexed versions. It frames the scope as upgrade planning, which clearly distinguishes it from sibling tools that list versions, search docs, read chunks, or outline a page.

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

Usage Guidelines3/5

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

Usage is only implied by the parenthetical '(upgrade planning)' and by the version defaults. The description does not explicitly say when not to use this tool or point to alternatives such as list_versions for discovering versions or search_docs for searching content.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.