Skip to main content
Glama
illodev

Workfile

by illodev
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Local

Create a release

project_changelog_release
Destructive

Turn unreleased changelog fragments into a single release record. Moves fragment files into the release directory to finalize the changelog.

Instructions

Consume selected unreleased fragments and create a canonical release record. This moves fragment files into the release directory, so preview first: the fragments stop being separately editable.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoMarkdown prelude written above the generated entries.
dateNoRelease date, YYYY-MM-DD. Defaults to today.
tagsNoFree-form tags for filtering.
titleNoRelease title. Defaults to the version itself.
commitNoCommit SHA this release was cut from.
versionYesVersion being cut, e.g. 0.5.4. Validated against changelog.releaseStrategy.
visibilityNoVisibility of the release record itself, typically public or internal. Project-declared, so the accepted values vary; project_workspace reports them.
fragmentIdsNoFragments to consume, e.g. CHG-0101. Omit to consume every unreleased fragment.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
recordYesThe release record that was created.
consumedFragmentsYesFragments that moved into the release directory and no longer exist as unreleased records.

Schema Changelog

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

  1. Changed9 schema fields changedv0.5.4
    • addedInput schema / properties / body / description
      Added value: +"Markdown prelude written above the generated entries."
    • addedInput schema / properties / commit / description
      Added value: +"Commit SHA this release was cut from."
    • addedInput schema / properties / date / description
      Added value: +"Release date, YYYY-MM-DD. Defaults to today."
    • addedInput schema / properties / fragmentIds / description
      Added value: +"Fragments to consume, e.g. CHG-0101. Omit to consume every unreleased fragment."
    • addedInput schema / properties / tags / description
      Added value: +"Free-form tags for filtering."
    • addedInput schema / properties / title / description
      Added value: +"Release title. Defaults to the version itself."
    • addedInput schema / properties / version / description
      Added value: +"Version being cut, e.g. 0.5.4. Validated against changelog.releaseStrategy."
    • addedInput schema / properties / visibility / description
      Added value: +"Visibility of the release record itself, 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": {
+    "consumedFragments": {
+      "description": "Fragments that moved into the release directory and no longer exist as unreleased records.",
+      "items": {
+        "additionalProperties": true,
+        "description": "A record in list projection: identity and frontmatter without the Markdown body.",
+        "properties": {
+          "bodyBytes": {
+            "description": "Size in bytes of the body this projection left out.",
+            "type": "integer"
+          },
+          "created": {
+            "description": "Creation date, YYYY-MM-DD.",
+            "type": "string"
+          },
+          "id": {
+            "description": "Stable record ID: T-0042, DOC-0003, CHG-0101, ADR-0009.",
+            "type": "string"
+          },
+          "incomingTotal": {
+            "description": "How many other records link to this one.",
+            "type": "integer"
+          },
+          "kind": {
+            "description": "Record family: card, doc, change, release or memory.",
+            "type": "string"
+          },
+          "path": {
+            "description": "Repository-relative path to the Markdown file.",
+            "type": "string"
+          },
+          "recordType": {
+            "description": "Type within the family — a card's type, a document's kind, a memory record's collection.",
+            "type": "string"
+          },
+          "status": {
+            "description": "Lifecycle status, in the vocabulary of this record's family.",
+            "type": "string"
+          },
+          "title": {
+            "description": "Human-readable title.",
+            "type": "string"
+          },
+          "updated": {
+            "description": "Date of the last write, YYYY-MM-DD.",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "record": {
+      "additionalProperties": true,
+      "description": "The release record that was created.",
+      "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",
+    "consumedFragments"
+  ],
+  "type": "object"
+}
  2. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations provide readOnlyHint=false and destructiveHint=true, but the description adds genuine value by explaining the specific destructive consequence: 'the fragments stop being separately editable' and that files are moved into the release directory. This goes beyond the annotation's generic destructive flag, warning the agent that the action is irreversible for those fragments. Combined with the destructiveHint=true annotation, this is solid behavioral disclosure.

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 sentences, zero waste. Each sentence earns its place: the first states the action and resource, the second adds the critical destructive consequence and preview instruction. Front-loaded and efficient.

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?

The tool has 8 parameters but all are documented in the 100%-covered schema. It has an output schema and destructiveHint annotation. The description explains the core destructive behavior (moving fragments, losing separate editability) and the preview prerequisite. Given the complexity of the release operation, the description is adequate though it could mention what the output schema contains; however, with an output schema present, the description isn't required to explain return values.

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 description coverage is 100%, so every parameter is documented in the schema itself. The description adds marginal value: it clarifies the semantics of the key destructive parameter (fragmentIds: 'Omit to consume every unreleased fragment') which is a meaningful behavioral note. However, most parameter meaning is carried by the schema descriptions, so the baseline-3 applies.

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 clearly states the verb+resource+outcome: 'Consume selected unreleased fragments and create a canonical release record.' It distinguishes from siblings by describing the fragment-to-release mechanism, which is unique among changelog-related tools (project_changelog_add/list/patch/preview don't aggregate fragments into a release).

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 context: you consume fragments and create a release record. It implies this is the finalization step and that previewing (project_changelog_preview) is a prerequisite via 'preview first'. It doesn't explicitly name the sibling alternative or give when-not scenarios, but the guidance is strong enough for selecting this tool over changelog add/patch/preview.

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

Install Server

Other Tools

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