gitlab-api

Gitlab Instances Get

gitlab_instances_get

Read-only

Retrieve configuration details for a named GitLab instance, including its URL, token presence, and TLS profile status.

Instructions

Read one configured GitLab tenant: url, whether a token and a TLS profile are set.

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": {
      "name": "<name>"
    },
    "name": "gitlab_instances_get"
  }
}

Input Schema

Name	Required	Description	Default
`name`	Yes	Instance name.

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv27.3.20Nov 7, 2026
- removedInput schema / properties / name / default
```
Removed value: -""
```
- changedInput schema / properties / name / description
```
Previous value: -"Instance name for action='get'."New value: +"Instance name."
```
- addedInput schema / required
```
Added value: +[
+  "name"
+]
```
First observedv27.3.13Oct 25, 2026

TDQS

A3.8/5.0

Behavior4/5

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

Annotations only declare readOnlyHint=true, so the description carries the rest; it usefully discloses that the record exposes the URL plus only booleans for token and TLS profile presence (no secrets returned). It does not say what happens when the name does not resolve to a configured instance.

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?

A single front-loaded sentence with the verb, scope, and returned fields in order of importance; there is no filler or redundant restatement of the title.

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?

For a one-parameter read with no output schema, the description covers intent, scope, and the shape of the response, which is what an agent needs to call it. Only the not-found/error behavior is left unstated.

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 100% ('Instance name.'), so the baseline applies. The description adds a small amount of meaning by implying the name must match an already-configured tenant rather than an arbitrary string, but gives no format or matching guidance beyond that.

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?

The description gives a specific verb and resource ('Read one configured GitLab tenant') and enumerates the fields surfaced (url, token presence, TLS profile presence), so an agent knows exactly what it returns. It does not name or distinguish itself from the sibling gitlab_instances_list, which is the obvious alternative for enumeration.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The word 'one' implies a single-record lookup as opposed to a listing, which lets an agent infer the split with gitlab_instances_list, but the sibling is never named and no explicit when-to-use or when-not-to-use condition is stated.

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

Deploy Server