Skip to main content
Glama

get_group

Read-onlyIdempotent

Retrieve a security group's membership criteria and effective member count, including up to 50 VM members, to assess its true size.

Instructions

[READ] Get details of a security group including membership criteria and effective members.

Returns one group object: its expression rules, member_count (the group's real size), and members — an envelope holding at most the first 50 effective VirtualMachine members, whose truncated flag says whether more were withheld. Report member_count as the size; counting members.items reports the sample instead. Use it once list_groups has narrowed to one id; membership is evaluated by NSX, so a tag written with apply_vm_tag may take seconds to appear.

Args: group_id: Group identifier (e.g. 'web-tier-vms'). target: Optional NSX Manager target from config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNo
group_idYes
Behavior5/5

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

Beyond the annotations (readOnlyHint, idempotentHint, etc.), the description reveals crucial behaviors: member_count is the real size while members.items is only a capped sample of 50, the truncated flag indicates more items, and membership changes may take seconds to propagate. This adds significant context not encoded in annotations or schema.

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?

The description is appropriately sized and front-loaded with '[READ]' and a clear summary. Each subsequent sentence adds a distinct, necessary detail (return structure, truncation, usage context, timing). There is no redundancy or filler.

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

Completeness5/5

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

Despite lacking an output schema, the description thoroughly explains what the return object contains, how to interpret the truncated members list, and the relationship between member_count and members.items. It also covers the prerequisite of using list_groups and the eventual consistency behavior, making it fully self-sufficient for an agent.

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

Parameters5/5

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

Even though the schema has no descriptions for the parameters, the 'Args' section provides meaningful examples for group_id ('web-tier-vms') and clarifies that target is an optional NSX Manager target. This enriches the bare schema definitions with practical context and default behavior.

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

Purpose5/5

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

The description opens with '[READ] Get details of a security group including membership criteria and effective members,' clearly stating the verb (get), resource (security group), and the specific details returned. It differentiates itself from siblings like list_groups (which narrows to one id) and get_dfw_policy (a different resource type).

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

Usage Guidelines5/5

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

It explicitly instructs 'Use it once list_groups has narrowed to one id,' providing clear when-to-use guidance and naming the alternative (list_groups). It also adds a key temporal caveat about NSX evaluation delays, helping the agent know what to expect when using it in a workflow.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/vmware-skills/VMware-NSX-Security'

If you have feedback or need assistance with the MCP directory API, please join our Discord server