Skip to main content
Glama

release_notes

Read-only

Generate release notes from a project milestone, summarizing features, fixes, pull requests, and still-open items in one view.

Instructions

Release notes from a milestone: features, fixes, PRs, still open

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "projectIdentifier": "<projectIdentifier>",
      "milestoneLabel": "<milestoneLabel>"
    },
    "name": "release_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspaceNo
milestoneLabelYesMilestone name
projectIdentifierYesProject key

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.5.1

TDQS

B3.1/5.0
Behavior3/5

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

readOnlyHint=true already establishes this is a safe read, so the description's job is to add context, which it partially does by disclosing that still-open items are included in the output. That phrase is ambiguous, though: it could mean open issues are listed in the notes or that open items are a filter, and no ordering, grouping, or completeness behavior is given.

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

Conciseness3/5

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

It is a single front-loaded fragment with almost no waste, but the compression costs clarity: 'still open' reads as a dangling clause and the colon-list mixes content types with a status qualifier. Sizing is appropriate for a simple read tool, but one more clause would have paid for itself.

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?

With no output schema, the description is the only signal about what comes back, and it gives only topical categories without structure or format. Annotations cover safety well and the schema covers most parameters, so nothing critical is missing for correct invocation, but the agent cannot predict the shape of the result.

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 67%, with milestoneLabel and projectIdentifier documented inline and workspace left bare. The description adds no meaning to any of the three parameters, so it neither compensates for the undocumented workspace nor clarifies how milestoneLabel resolves. Baseline 3 fits a schema that does most of the work.

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?

Names a specific output artifact (release notes) and its source (a milestone), plus the content classes it aggregates: features, fixes, PRs, and still-open items. An agent can tell this is a composite read, not a single-issue fetch. It stops short of differentiating from the sibling 'release_issue' or stating whether notes are assembled client-side or generated server-side.

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 when-to-use or when-not-to-use guidance and no named alternative; the milestone scoping is the only implicit signal. An agent must infer that this is the aggregate view to choose over per-issue lookups, which is exactly the inference the description should save it from making.

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

Deploy Server

Other Tools