GitLab Tool

Introduction

The GitLab tool connects your agent to a single GitLab project and gives it read access to issues, milestones, merge requests, code diffs, members, and labels.

What it does

The GitLab tool authenticates with the GitLab REST API using a personal access token and exposes nine read-only functions the agent can call. The agent decides which function to use based on what the question requires. All nine functions are scoped to the project you configure at setup time.

The nine available functions are the following:

• List milestone issues: all issues in a configured milestone.
• Get issue details: full details of one issue by its project-internal number.
• Get issue comments: the human-written comments on an issue.
• Get issue merge requests: the merge requests linked to an issue.
• Get MR diffs: the code changes in a specific merge request.
• List issues: a filtered, paginated list of project issues.
• List milestones: all project milestones with open and closed issue counts.
• List project members: all members with their access levels.
• List labels: all project labels with descriptions.

This tool is read-only. It cannot create issues, post comments, or merge requests.

Get started

How to use it

To use the GitLab Tool:

1. Locate the GitLab element under the Tools section of the palette.
2. Drag and drop the File element into the Drop a tool to here section.
   

Configure Tool Properties

To properly integrate and configure the Google Web Search, set the following fields:

• GitLab URL: The base URL of your GitLab instance. https://gitlab.com for the hosted service, or your self-hosted URL, for example https://gitlab.yourcompany.com. No trailing slash needed. This is a required field.
• Project ID: Identifies the project all API calls are scoped to. The numeric project ID shown on the project's main page in GitLab. This is a required field.
• Private Token: Authenticates all API calls. A personal access token with read_api scope. Stored encrypted. This is a required field.
• Milestone ID: The milestone used by the List milestone issues function. The numeric milestone ID from the GitLab URL when you view that milestone. Leave blank if you do not need this function.
• Max Notes Per Issue: Limits the comments returned per issue by the Get issue comments function. A number. The default is 50. Set to 0 for no limit, but be aware that busy issues can have hundreds of comments.

Best Practices

• Find the Project ID on the project's main page. In GitLab, it appears below the project name. Copy the numeric value, not the path.
• The Milestone ID is required for the List milestone issues function. If this field is blank, that specific function throws an error when called. The List issues function with a milestone filter still works without it.
• The tool makes calls from the Joget server, not from your browser. In firewalled or air-gapped environments, confirm that the Joget server has outbound access to your GitLab host before saving the configuration.
• Issue numbers in GitLab are project-internal. When you retrieve an issue's details or comments, the number you pass is the one visible in the GitLab URL, not a global database identifier.
• Set Max Notes Per Issue to a realistic limit. For busy projects, uncapped comment fetches can return very large payloads that consume a significant portion of the agent's context window.