Skip to main content
Glama

Publish release

publish_release

Publish a release note to your LogPulse changelog right after shipping — with version, breaking changes, migration steps and deprecations. Needs a LogPulse API key with the “Publish releases” permission, sent as the Authorization header.

Input Schema

NameRequiredDescriptionDefault
bodyNoRelease notes in Markdown.
slugNoURL slug. Defaults to the title.
titleYesShort, user-facing headline, e.g. “Webhooks retry automatically”.
labelsNoUp to 10 short labels, e.g. API, Dashboard.
statusNopublished (default) goes live now, or at published_at. draft saves it for a human to review in LogPulse.published
summaryNoOne sentence for lists and link previews.
versionNoVersion this release ships in, e.g. 2.0.0. Unique per changelog.
categoryNonew, improved or fixed. Default new.new
author_nameNoShown as the author. Defaults to the API key's name.
deprecationsNoWhat is deprecated, its replacement and planned removal version.
published_atNoSchedule a future time, or backdate an import.
breaking_changesNoWhat breaks for existing users, each with migration steps.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false and openWorldHint=false. The description adds real value the annotations do not: the required credential scope and header, which an agent must verify before attempting the write. However it omits consequences the annotations leave implicit — that publishing is externally visible, that a duplicate version will fail, and 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.

Conciseness5/5

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

Two sentences, front-loaded with the action and its payload scope, second sentence carrying the prerequisite. No filler and nothing repeated from the schema.

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 12-parameter mutation with no output schema, the description says nothing about the return value (release ID, slug, URL) that an agent would need to chain a follow-up call. The auth prerequisite helps, but the mutation's side effects and response shape remain undocumented.

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 one of the 12 parameters is already documented in-schema, and the description merely echoes the headline fields (version, breaking changes, migration, deprecations). It adds no guidance beyond the schema, such as which fields are ignored when status=draft — 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?

States a specific verb ('Publish') and resource ('a release note to your LogPulse changelog') and enumerates the payload dimensions (version, breaking changes, migration steps, deprecations). This is unambiguously distinct from read-only siblings like get_release, list_releases, and get_changelog.

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?

Adds timing context ('right after shipping') and a hard prerequisite (API key with the 'Publish releases' permission in the Authorization header), which tells the agent when the call is appropriate and what must be in place. It stops short of exclusions or naming alternatives — e.g. nothing says to use a draft path or a different tool when the changelog is unreviewed.

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