Skip to main content
Glama

Get changelog

get_changelog
Read-only

Get a changelog by ID, including its labels, linked feature requests, and translations.

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": {
      "changelog_id": "<changelog_id>"
    },
    "name": "get_changelog"
  }
}

Input Schema

NameRequiredDescriptionDefault
changelog_idYesThe ID of the changelog (from list_changelogs).

Output Schema

NameRequiredDescriptionDefault
changelogNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered elsewhere. The description earns some credit by disclosing that related entities (labels, feature requests, translations) are returned inline, which affects whether follow-up calls are needed, but it says nothing about not-found/error behavior or permissions.

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?

One front-loaded sentence with the resource, key, and payload scope; no filler, no redundancy with the title.

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 one-parameter read tool with full schema coverage, an output schema, and safety annotations, the description covers what is needed to select and call it. The only material omission is failure behavior for an invalid or missing changelog_id.

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

Parameters3/5

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

Schema coverage is 100% and the single parameter already documents that the ID comes from list_changelogs. The description only restates 'by ID' and adds no format, range, or validity constraints beyond the schema, so the baseline 3 applies.

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?

States a specific verb and resource ('Get a changelog by ID') and enumerates what the payload contains: labels, linked feature requests, translations. The 'by ID' framing implicitly separates it from list_changelogs and search_changelogs, though neither sibling is named, so it falls just short of a 5.

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: retrieval of a single changelog when the ID is already known. There is no explicit when-to-use versus search_changelogs/list_changelogs, and no stated precondition about where the ID must come from in the description itself (that hint lives in the schema).

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.