Skip to main content
Glama

delimit_changelog

Generate a formal changelog entry from git commits or OpenAPI spec diffs, categorizing changes and optionally prepending to CHANGELOG.md.

Instructions

Generate a changelog from git + ledger (git mode) or spec diff (spec mode).

When to use: as part of the deploy gate chain to produce a release note, or to prepend a CHANGELOG.md entry for a tagged release. When NOT to use: for ad-hoc human prose explanation of a spec change (use delimit_explain) or release planning (delimit_release_plan).

Sibling contrast: delimit_explain renders human prose for one diff; delimit_release_plan plans services and versions; this generates a formal changelog entry.

Two modes:

  1. Git mode (pass repo_path): reads git log since last tag, categorizes commits (feat/fix/refactor/docs/test/ci), pulls completed ledger items, formats as Markdown. Works for ANY repo.

  2. Spec mode (pass old_spec + new_spec): compares two OpenAPI specs and produces an API changelog.

Side effects: read-only on git/spec inputs. Writes to output_file when provided. If output_file is "CHANGELOG.md", PREPENDS the entry rather than overwriting — preserving prior history.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
old_specNoOld OpenAPI spec path (spec mode).
new_specNoNew OpenAPI spec path (spec mode).
formatNo"markdown" (default), "json", "keepachangelog", "github-release".markdown
versionNoVersion label (e.g. "4.1.0").
repo_pathNoRepo path (git mode).
since_tagNoGit tag to diff from. Empty = auto-detect latest tag.
include_ledgerNoInclude completed ledger items (git mode). Default True.
output_fileNoWrite the rendered changelog here. If "CHANGELOG.md", prepends the entry.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior5/5

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

No annotations exist, so description fully bears the burden. It details read-only nature on inputs, side effects of writing to output_file, and the special prepend behavior for 'CHANGELOG.md'. It also describes the two modes and their effects.

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?

Well-structured with clear sections: when to use, when not to use, sibling contrast, two modes. Each sentence adds value, no fluff. Front-loaded with purpose.

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?

Given 8 parameters, two modes, and absence of annotations, the description is thorough. It explains mode selection, parameters, side effects, and contrasts with related tools. The output schema exists but description doesn't need to explain return values.

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 100% (all 8 parameters described). The description adds value by linking parameters to modes (e.g., repo_path for git mode, old_spec/new_spec for spec mode) and clarifying the prepend behavior for output_file. This goes beyond the schema.

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 clearly states the tool generates a changelog from git+ledger (git mode) or spec diff (spec mode). It distinguishes itself from siblings like delimit_explain (human prose) and delimit_release_plan (release planning).

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?

Explicitly states when to use (part of deploy gate chain, producing release notes, prepending CHANGELOG.md) and when NOT to use (ad-hoc explanations, release planning) with alternative tools named. This provides clear guidance.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/delimit-ai/delimit-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server