Skip to content

releases.md

Latest commit

 

History

History
126 lines (86 loc) · 8.1 KB

releases.md

File metadata and controls

126 lines (86 loc) · 8.1 KB
Raw

Releases

Release lifecycle, release evidence, and asset download.

!!! note "Feature toggle" Opt-in. Enable via GITLAB_TOOLSETS=releases (or GITLAB_TOOLSETS=all), list individual tools in GITLAB_TOOLS=, or activate at runtime with the discover_tools MCP tool.

Tools in this group

list_releases

📖 Read-only

List all releases for a project. Use this for a collection of resources; choose the corresponding get tool when you already know the single resource to inspect. It is read-only and does not mutate GitLab data; missing resources, invalid identifiers, insufficient permission, and rate limits are returned as errors. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Parameters

Parameter Type Required Description
project_id string ✓ Project ID or URL-encoded path
order_by enum (released_at | created_at) The field to use as order. Either released_at (default) or created_at.
sort enum (desc | asc) The direction of the order. Either desc (default) for descending order or asc for ascending order.
include_html_description boolean If true, a response includes HTML rendered Markdown of the release description.
page number Page number for pagination (default: 1)
per_page number Number of items per page (max: 100, default: 20)

get_release

📖 Read-only

Get a release by tag name. Use this for a known resource or result; choose the corresponding list or search tool when you need to discover multiple resources. It is read-only and does not mutate GitLab data; missing resources, invalid identifiers, insufficient permission, and rate limits are returned as errors. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Parameters

Parameter Type Required Description
project_id string ✓ Project ID or URL-encoded path
tag_name string ✓ The Git tag the release is associated with
include_html_description boolean If true, a response includes HTML rendered Markdown of the release description.

create_release

✏️ Writes

Create a new release. Use this for a new resource or action; choose the corresponding update or edit tool when the resource already exists. It changes remote GitLab state and requires the necessary project or group permission; GitLab returns validation, conflict, permission, or rate-limit errors instead of silently applying an invalid request. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Parameters

Parameter Type Required Description
project_id string ✓ Project ID or URL-encoded path
tag_name string ✓ The tag where the release is created from
name string The release name
tag_message string Message to use if creating a new annotated tag
description string The description of the release. You can use Markdown.
ref string If a tag specified in tag_name doesn't exist, the release is created from ref and tagged with tag_name. It can be a commit SHA, another tag name, or a branch name.
milestones array The title of each milestone the release is associated with. GitLab Premium customers can specify group milestones.
assets object An array of assets links
released_at string Date and time for the release. Defaults to the current time. Expected in ISO 8601 format (2019-03-15T08:00:00Z). Only provide this field if creating an upcoming or historical release.

update_release

✏️ Writes

Update an existing release. Use this for an existing resource; choose the corresponding create tool for a new resource and a note tool for discussion-only text. It changes remote GitLab state and requires the necessary project or group permission; GitLab returns validation, conflict, permission, or rate-limit errors instead of silently applying an invalid request. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Parameters

Parameter Type Required Description
project_id string ✓ Project ID or URL-encoded path
tag_name string ✓ The Git tag the release is associated with
name string The release name
description string The description of the release. You can use Markdown.
milestones array The title of each milestone to associate with the release. GitLab Premium customers can specify group milestones. To remove all milestones from the release, specify [].
released_at string The date when the release is/was ready. Expected in ISO 8601 format (2019-03-15T08:00:00Z).

delete_release

✏️ Writes

Delete a release (does not delete the tag). Use this only after verifying the target; choose a get or list tool first when you need to inspect state without changing it. It changes or removes remote GitLab data and may be irreversible; it requires the necessary project or group permission and returns validation, conflict, permission, or rate-limit errors. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Parameters

Parameter Type Required Description
project_id string ✓ Project ID or URL-encoded path
tag_name string ✓ The Git tag the release is associated with

create_release_evidence

✏️ Writes

Create release evidence (Premium/Ultimate). Use this for a new resource or action; choose the corresponding update or edit tool when the resource already exists. It changes remote GitLab state and requires the necessary project or group permission; GitLab returns validation, conflict, permission, or rate-limit errors instead of silently applying an invalid request. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Parameters

Parameter Type Required Description
project_id string ✓ Project ID or URL-encoded path
tag_name string ✓ The Git tag the release is associated with

download_release_asset

📖 Read-only

Download a release asset file by direct asset path. Use this for the specific operation described; choose a sibling tool when you need a different resource or lifecycle action. It is read-only and does not mutate GitLab data; missing resources, invalid identifiers, insufficient permission, and rate limits are returned as errors. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Parameters

Parameter Type Required Description
project_id string ✓ Project ID or URL-encoded path
tag_name string ✓ The Git tag the release is associated with
direct_asset_path string ✓ Path to the release asset file as specified when creating or updating its link