gitlab-api

Get users

gitlab_get_users

Read-onlyIdempotent

Retrieve GitLab users with filters for active, blocked, admin, email, username, and pagination to find accounts and build user reports.

Instructions

Get information about users.

Args: **kwargs: Additional parameters for the request (e.g., per_page, page).

Returns: Response: A wrapper containing the original response and a list of User models.

Raises: ParameterError: If invalid parameters are provided.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "gitlab_get_users"
  }
}

Input Schema

Name	Required	Description	Default
`data`	No
`name`	No
`page`	No
`sort`	No
`sudo`	No
`admin`	No
`email`	No
`active`	No
`admins`	No
`humans`	No
`blocked`	No
`user_id`	No
`external`	No
`order_by`	No
`password`	No
`per_page`	No
`provider`	No
`username`	No
`max_pages`	No
`extern_uid`	No
`two_factor`	No
`total_pages`	No
`created_after`	No
`created_before`	No
`exclude_external`	No
`exclude_internal`	No
`saml_provider_id`	No
`without_projects`	No
`skips_confirmation`	No
`without_project_bots`	No
`with_custom_attributes`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv27.3.20Nov 7, 2026

removedInput schema / properties / api_parameters

Removed value: -{
-  "anyOf": [
-    {
-      "additionalProperties": true,
-      "type": "object"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null
-}

changedInput schema / properties / sudo / default
```
Previous value: -falseNew value: +null
```

First observedv27.3.13Oct 25, 2026

TDQS

C2.4/5.0

Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint and non-destructive, so the safety profile is covered. The description adds only that it returns a wrapper with User models and may raise ParameterError; it says nothing about pagination behavior despite page/per_page/max_pages/total_pages parameters, nor about permission requirements for admin-only filters.

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 short and front-loads the purpose, but the docstring scaffolding (Args/Returns/Raises) is boilerplate and the "**kwargs: Additional parameters" line is a placeholder rather than real information. Some space is spent restating the return type rather than explaining the listing semantics.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 31-parameter list endpoint with no output schema and zero schema descriptions, the definition is far too thin: an agent cannot tell what the filters do, how paging terminates, or what scope of users is returned. Only the error type and a vague return shape are covered.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% across 31 parameters, so the description must carry the burden and largely does not. It names only per_page and page as examples inside a generic **kwargs line, leaving 29 filters (admin, blocked, external, created_after, order_by, without_project_bots, etc.) completely undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Get information about users" states a verb and resource, but it reads as a generic retrieval and does not make clear that this is a list/collection endpoint with filtering, nor does it distinguish itself from the sibling gitlab_get_user (single user). An agent must infer from the plural that this returns many users.

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 guidance on when to use this tool versus gitlab_get_user for a single lookup, nor any mention of the filtering scenarios (admins, blocked, external, created date ranges) that the parameters support. The only hint at behavior is the kwargs note about per_page and page.

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

Deploy Server