Skip to main content
Glama

Create a changelog entry

create_changelog_entry

Write a changelog entry. It is a draft unless status is "published", which shows it on the public changelog and in the widget.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoThe entry in Markdown.
tagsNo
titleYes
statusNoDefaults to "draft".
summaryNoOne line shown in lists.
versionNoA version label, e.g. "2.4".
productIdYesProduct id from list_products.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations declare the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), so the bar is lower, and the description still adds real behavioral context: the entry is a draft by default and only 'published' status exposes it on the public changelog and widget. That public-visibility side effect is exactly the kind of consequence an agent needs before setting status. It omits auth/permission requirements and whether publishing is reversible.

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?

Two short sentences, zero filler, with the core action front-loaded and the consequential status behavior immediately after. Every clause earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 7-parameter creation tool with no output schema, the description covers the publishing side effect but not the required parameters (productId, title) or the return value an agent would need an entry id for later update/delete. Adequate but with clear gaps.

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 71%, so the schema documents most fields. The description adds genuine meaning for 'status' by explaining what 'published' actually does (public changelog + widget visibility), which goes beyond the schema's bare 'Defaults to draft'. It says nothing about body, tags, version, or summary, so moderate value only.

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 ('Write a changelog entry'), so the action is unambiguous. It does not, however, differentiate itself from close siblings like update_changelog_entry, draft_changelog_from_releases, or delete_changelog_entry, leaving that disambiguation to the name alone.

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

Usage Guidelines2/5

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

The description contains no when-to-use or when-not-to-use guidance and never names an alternative such as update_changelog_entry (for modifying an existing entry) or draft_changelog_from_releases (for AI-assisted drafting). An agent must infer usage purely from the verb 'write'.

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.

Resources