Skip to main content
Glama

create_changelog_entry

Destructive

Record a service status transition atomically as a changelog entry, so owned services keep consistent incident updates.

Instructions

Record a status transition atomically for an owned service.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNo
titleYes
statusYes
service_idYes
visibilityYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, and openWorldHint=true, so the safety profile is largely covered. The description adds useful context by stating the operation is atomic and tied to an owned service, but it does not explain what exactly is mutated, what permissions are required, or what the side effects are beyond the annotation hints.

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?

The description is a single front-loaded sentence with no filler or redundant clauses. It is structurally clean, though it is arguably too sparse for a five-parameter mutation tool.

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

Completeness2/5

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

For a tool with five parameters, four of them required, two enums, no output schema, and zero schema descriptions, the description is far too thin. It states the core action but omits parameter semantics, mutation details, permission requirements, and usage conditions that an agent would need to invoke it correctly.

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

Parameters2/5

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

Schema description coverage is 0% and all five parameters lack descriptions. The description weakly implies a status parameter and a service identifier via 'status transition' and 'owned service', but it says nothing about title, visibility, or body, leaving most input semantics to the bare schema.

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?

The description gives a specific verb ('Record') and resource ('status transition') plus a scope ('for an owned service'), so the basic action is clear. However, it does not explicitly call out 'changelog entry' or differentiate from sibling tools such as create_entry, leaving sibling selection to inference.

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?

There is no explicit guidance about when to use this tool versus alternatives like create_entry, create_comment, or get_changelog. The phrase 'for an owned service' implies a precondition, but it never states when the tool should or should not be selected.

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