edgegate_list_members

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

With no annotations provided, the description carries full burden. It discloses the authorization requirement ('Requires at least viewer role') and the return contents (email + role). It doesn't discuss pagination or filtering, but for a simple list this is adequate.

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

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

Two sentences, no extraneous words. Front-loaded with the action and output fields, then a necessary permission note.

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

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

For a simple one-parameter read tool, the description covers what it does, what it returns, and the required role. It is complete enough for an agent to select and invoke it, though it lacks alternative tool guidance.

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

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

The schema has one parameter (workspace_id) with zero description coverage. The tool description does not mention workspace_id or how it relates to the workspace, so it fails to compensate for the missing schema info. However, the parameter name and uuid format are self-explanatory.

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

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

The description states the verb 'List' and resource 'all members of this workspace', with specific output fields (email + role). It is clear and distinct from sibling tools such as list_devices or list_api_keys, though it doesn't explicitly reference alternatives.

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

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

No guidance on when to use this tool versus alternatives. The note 'Requires at least viewer role' is a permission prerequisite, not a usage guideline. The description doesn't mention alternative tools like get_report or list_devices.

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