Skip to main content
Glama

Add a changelog fragment

project_changelog_add

Create atomic unreleased changelog fragments for each user-visible change, linking to cards, decisions, or records. Capture changes when they land so the changelog stays release-ready and traceable.

Instructions

Create an atomic unreleased changelog fragment and relate it to cards, decisions or other records. One fragment per user-visible change, written when the change lands rather than when the release is cut.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
areaNoPart of the system that changed. Project-declared, so the accepted values vary; project_workspace reports them.
bodyNoMarkdown body, written below the frontmatter.
tagsNoFree-form tags for filtering.
typeNoWhat kind of change this is — added, changed, fixed and so on. Project-declared, so the accepted values vary; project_workspace reports them.
cardsNoIDs of the cards this change came from.
titleYesThe change, stated from the reader's side rather than the implementer's.
issuesNoExternal issue or ticket references.
relatedNoIDs of other records worth reading alongside.
decisionsNoIDs of decision records this change implements.
visibilityNoWho the entry is rendered for, typically public or internal. Project-declared, so the accepted values vary; project_workspace reports them.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
recordYesA canonical record with its body, revision and reference graph.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed11 schema fields changedv0.5.4
    • addedInput schema / properties / area / description
      Added value: +"Part of the system that changed. Project-declared, so the accepted values vary; project_workspace reports them."
    • addedInput schema / properties / body / description
      Added value: +"Markdown body, written below the frontmatter."
    • addedInput schema / properties / cards / description
      Added value: +"IDs of the cards this change came from."
    • addedInput schema / properties / decisions / description
      Added value: +"IDs of decision records this change implements."
    • addedInput schema / properties / issues / description
      Added value: +"External issue or ticket references."
    • addedInput schema / properties / related / description
      Added value: +"IDs of other records worth reading alongside."
    • addedInput schema / properties / tags / description
      Added value: +"Free-form tags for filtering."
    • addedInput schema / properties / title / description
      Added value: +"The change, stated from the reader's side rather than the implementer's."
    • addedInput schema / properties / type / description
      Added value: +"What kind of change this is — added, changed, fixed and so on. Project-declared, so the accepted values vary; project_workspace reports them."
    • addedInput schema / properties / visibility / description
      Added value: +"Who the entry is rendered for, typically public or internal. Project-declared, so the accepted values vary; project_workspace reports them."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "record": {
      +      "additionalProperties": true,
      +      "description": "A canonical record with its body, revision and reference graph.",
      +      "properties": {
      +        "archived": {
      +          "description": "Whether the record lives in the archive directory.",
      +          "type": "boolean"
      +        },
      +        "body": {
      +          "description": "Markdown body below the frontmatter.",
      +          "type": "string"
      +        },
      +        "created": {
      +          "description": "Creation date, YYYY-MM-DD.",
      +          "type": "string"
      +        },
      +        "file": {
      +          "description": "File name within the collection directory.",
      +          "type": "string"
      +        },
      +        "id": {
      +          "description": "Stable record ID.",
      +          "type": "string"
      +        },
      +        "incoming": {
      +          "description": "Backlinks: references other records make to this one.",
      +          "items": {
      +            "additionalProperties": true,
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "incomingTotal": {
      +          "description": "Total backlinks, which may exceed the returned page.",
      +          "type": "integer"
      +        },
      +        "issues": {
      +          "description": "Validation findings doctor would report for this record.",
      +          "items": {
      +            "additionalProperties": true,
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "kind": {
      +          "description": "Record family: card, doc, change, release or memory.",
      +          "type": "string"
      +        },
      +        "outgoing": {
      +          "description": "References this record makes to others.",
      +          "items": {
      +            "additionalProperties": true,
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "path": {
      +          "description": "Repository-relative path to the Markdown file.",
      +          "type": "string"
      +        },
      +        "recordType": {
      +          "description": "Type within the family.",
      +          "type": "string"
      +        },
      +        "revision": {
      +          "description": "Content hash to pass back as expectedRevision on the next write.",
      +          "type": "string"
      +        },
      +        "status": {
      +          "description": "Lifecycle status.",
      +          "type": "string"
      +        },
      +        "tags": {
      +          "description": "Free-form tags.",
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "title": {
      +          "description": "Human-readable title.",
      +          "type": "string"
      +        },
      +        "updated": {
      +          "description": "Date of the last write, YYYY-MM-DD.",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "record"
      +  ],
      +  "type": "object"
      +}
  2. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, so the mutating nature is already signaled; annotations do not contradict. The description adds behavioral context: fragments are 'unreleased' (they accumulate until a release tool consolidates them) and 'atomic', giving the agent a sense of scope and lifecycle. It doesn't detail response format or failure modes, but output schema and annotations cover some of this. Slight gap on what happens after creation, but the note about 'unreleased' is valuable.

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 sentences, no filler, front-loaded with the core purpose. The second sentence adds genuinely useful operational guidance (granularity and timing). Could arguably be trimmed but every word earns its place and nothing is redundant with the schema.

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

Completeness4/5

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

With 10 parameters but full schema coverage and a present output schema, the description's job is modest. It communicates the invariance rules (atomic, unreleased, timing) which the schema cannot express. It doesn't spell out the relation types fully, but the schema fields (cards, decisions, related, issues) cover that. Reasonably complete for a create-oriented tool.

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 10 parameters have structured descriptions already. The description adds the 'atomic' and 'unreleased' framing that connects to title/body semantics, but doesn't itself explain individual parameters. Per the baseline rule, schema is doing the heavy lifting, so 3 is appropriate.

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 states a specific verb+resource ('Create an atomic unreleased changelog fragment') and adds clear semantics: one fragment per user-visible change, written when the change lands rather than when release is cut. It also mentions relating to cards, decisions, or other records, which distinguishes it from siblings like project_changelog_patch (edits existing) and project_changelog_list (lists).

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

Usage Guidelines4/5

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

The description gives clear timing guidance ('written when the change lands rather than when the release is cut') and the atomicity rule ('One fragment per user-visible change'). It implies the creation use-case distinct from patch/release siblings, though it doesn't explicitly say 'use list/patch instead when...'. The timing and granularity advice is useful, context-rich guidance by name.

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

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/illodev/workfile'

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