Skip to main content
Glama
Sign In
ESET-MCP

ESET-MCP

by maciekaz
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

user_users__list_users

Read-onlyIdempotent

Retrieve and filter ESET users by email, display name, group, or protection status, with pagination and field selection to reduce token usage on large user lists.

Instructions

List users - (GET /v1/users) - Retrieves a list of users, optionally filtered by certain criteria defined in the user filter.

Input Schema

NameRequiredDescriptionDefault
emailNoFiltering based on the user's email. If filled, only the users containing the given `email` (at least partially) within the `primary email address` or `proxy email addresses` will be included in the response. If `null` or empty, users with any `email address` will be included in the response.
fieldsNoOptional server-side projection: return only these keys for each list-item in the response. Reduces token usage on large list endpoints. Example: ['uuid','displayName']. Top-level fields (e.g. nextPageToken) are always preserved. Not forwarded to ESET - applied locally after fetch.
pageSizeNoLimit for pagination purposes. If unspecified or 0, the default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000. > **Info:** > For more information, refer to [Paginating Requests in APIs](https://medium.com/@ignaciochiazzo/paginating-requests-in-apis-d4883d4c1c4c) > > or [Design Patterns: Pagination](https://google.aip.dev/158)
pageTokenNoPage token of the current page. If not given or "", the first page is returned. > **Info:** > For more information, refer to [Paginating Requests in APIs](https://medium.com/@ignaciochiazzo/paginating-requests-in-apis-d4883d4c1c4c) > > or [Design Patterns: Pagination](https://google.aip.dev/158)
displayNameNoFiltering based on the user's display name. If filled, only the users containing the given `display name` (at least partially) will be included in the response. If `null` or empty, users with any `display name` will be included in the response.
userGroupUuidNoFiltering based on the user's group. If `null` or empty, users from any user group will be included in the response. type: UserGroup
activeProduct.idNoIdentifier of the governed resource. It can be seen as the [value of the item in enumerated type](https://protobuf.dev/programming-guides/proto3/#enum). It can be derived from the name by some algorithm, such as CRC32.
protectionStatusNoFiltering based on the user's protection status. If not-null or non-zero, only the users with the given `protection status` will be included in the response. Otherwise, users with any `protection status` will be returned. - PROTECTION_STATUS_UNSPECIFIED: fallback - PROTECTION_STATUS_UNPROTECTED: Status where selected asset is not protected by enabled ESET protection features. - PROTECTION_STATUS_PENDING: Status where asset is not protected by enabled protection features yet, the protection is in pending state. The protection features are setting up. - PROTECTION_STATUS_PARTIALLY_PROTECTED: Status where asset is protected by enabled protection features, with some complications, that require the attention. - PROTECTION_STATUS_FULLY_PROTECTED: Status where asset is fully protected by enabled ESET protection features.PROTECTION_STATUS_UNSPECIFIED
activeProduct.nameNoName of the governed item. It can be seen as the name of the enumeration item, with `id` being its numerical value. > **Note:** > Not to be confused with `display_name`, which is [purposed for UI](https://google.aip.dev/148).
hasCloudOfficeMsLicenseNoIf `true`, include only users with an associated Microsoft (MS) cloud office license. If `false`, include only users without associated Microsoft (MS) cloud office license. If `null`, this filter does not apply at all.
activeProduct.unitPoolUuidNoReference to the [unit pool] used for product activation. Unit pools contain units available for product activation. type: unit_management.v1.UnitPool
cloudOfficeTenantReferenceNoFiltering based on the user's cloud office tenant reference. If filled, only the users of the given `cloud office tenant reference` will be included in the response. An exact match is required. If `null` or empty, users of any or none `cloud office tenant` will be included in the response.
activeProduct.autoActivatedNoIf `true`, the product was activated automatically. That is, the product was activated because it is automatically activated for all the users within some user's group or user's tenant.
activeProduct.subscriptionUuidNoReference to the [subscription] used for product activation. type: subscription_management.v1.Subscription
activeProduct.autoActivationDetails.baseNoBase, on which the product has been automatically activated for the user. For example, some products are activated based on automation at the level of the user's tenant. - PRODUCT_AUTO_ACTIVATION_BASE_UNSPECIFIED: fallback - PRODUCT_AUTO_ACTIVATION_BASE_TENANT: The product is activated for this user because automatic activation was enabled on the user's tenant. - PRODUCT_AUTO_ACTIVATION_BASE_USER_GROUP: The product is activated for this user because automatic activation was enabled on some of the user's groups.PRODUCT_AUTO_ACTIVATION_BASE_UNSPECIFIED
activeProduct.autoActivationDetails.userGroupUuidNoReference to the [user group]. It is only meaningful if the base is equal to the USER GROUP. type: UserGroup

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint, so the safety profile is covered. The description adds nothing beyond restating the operation — no note on default page size of 50, the 1000-result cap, or that filtering is substring-based for email/displayName while cloudOfficeTenantReference requires exact match.

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

Conciseness4/5

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

It is short and front-loaded with the verb and resource, with no filler. It is mildly redundant in restating "List users" as "Retrieves a list of users" and includes the raw HTTP route, which adds little for an agent.

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 16 optional filter parameters and no output schema, the description is thin: it never hints at the filter families available (protection status, active product, cloud office license, group) nor at any return shape. The rich schema compensates heavily, so the definition is adequate but not self-sufficient.

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 description coverage is 100%, so the detailed per-parameter semantics (partial vs exact matching, null handling, protection status enums, nested activeProduct filters) are already fully documented. The description's generic "certain criteria" adds no meaning beyond the schema, which is the expected baseline.

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 states a specific verb and resource ("List users"/"Retrieves a list of users") and notes optional filtering, so an agent immediately knows this is a user enumeration tool. It does not, however, distinguish itself from the sibling user_users__get_user, leaving the single-vs-list distinction to inference from the name.

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?

The only guidance is "optionally filtered by certain criteria defined in the user filter," which is circular and points to no concrete criteria. There is no statement of when to use this versus get_user, no mention that all parameters are optional and unfiltered calls return everything, and no pagination advice.

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