Changelogs for AI coding agents
Publish upgrade facts agents can retrieve without guessing from marketing prose.
01Use actual versions as retrieval boundaries
Put the package or product version on every upgrade-relevant release. Distinguish prereleases from stable releases and identify the package if a repository publishes several. A date-only announcement cannot reliably answer a dependency-version question.
02Represent breaking changes explicitly
Write a short summary, the affected symbol or behavior, and ordered migration instructions. Include deprecations with their replacements and known removal versions. Keep optional unknown values absent instead of filling them with fabricated certainty.
03Expose a stable machine-readable surface
LogPulse serves structured release data through JSON and the public MCP endpoint /mcp. MCP lets compatible clients retrieve facts through tools; it is not permission to write to a consumer repository. Link the API and MCP documentation for exact request formats.
04Review the retrieved upgrade path
Ask for changes between two real published versions and inspect the returned boundaries and omitted releases. The Acme 1.4.0 → 2.0.0 example demonstrates a version diff. Have the agent propose edits, then review diffs and run tests; release metadata does not prove an upgrade is correct.
Before and after
Too vague
AI-ready: lots of exciting changes.
Specific and actionable
Version 2.0.0. Breaking change: createClient({apiKey}) is replaced by createClient({token}). Migration: issue a scoped token, update initialization, then run authentication integration tests. Deprecated: legacy retryPolicy; use retry.maxAttempts.
Fictional example — use your own verified names, versions and behavior.
Before you publish
- Use real versions
- Populate breaking-change and deprecation fields
- Keep public notes free of secrets
- Test a version-range query
- Review generated edits and run tests
Common questions
Keep reading
LogPulse
Changelogs coding agents can upgrade from.
Publish versions, breaking changes, migration steps and deprecations once. People get a widget and hosted changelog; agents get a JSON feed and MCP server. Free for open source.