Skip to main content
Glama

Create changelog entry

create_changelog_entry

Write a changelog entry (the captain's log). Drafts by default; set publish to true to publish it immediately.

Input Schema

NameRequiredDescriptionDefault
titleYesEntry title
contentNoEntry body, markdown supported (optional)
publishNoPublish immediately (default: false)
categoryNoEntry category (default: new)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It does disclose the key state behavior that entries are drafted unless publish is set, which tells an agent the write is staged rather than immediately live. It says nothing about required permissions, whether drafts are editable later, or what the call returns.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the core action and followed by the most consequential parameter behavior. The 'captain's log' aside is decorative but does not obstruct comprehension.

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 simple four-parameter create tool with no annotations and no output schema, the description covers the essential draft-vs-publish distinction but omits what happens on failure, whether the entry is returned, and any prerequisite context. 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 100%, so all four parameters are already documented, making the baseline 3. The description reinforces the publish semantics ('set publish to true to publish it immediately') but adds nothing on category, content format, or title expectations beyond what the schema states.

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+resource ('Write a changelog entry') that an agent can immediately map to intent, and the parenthetical nickname reinforces the concept. It is clearly distinct from the read-oriented sibling list_changelog, though it never names that sibling explicitly.

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?

The description gives useful operating guidance for the publish flag (draft by default, set true to publish immediately), which implies a draft-then-publish workflow. It does not, however, say when to prefer this tool over siblings like create_feedback or update_feedback_status, leaving usage context implied.

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.