Skip to main content
Glama

list_portal_groups

Read-onlyIdempotent

List a portal's user groups: members, and for each table or report the group has rights on — its role and whether the group sees only its own records (tables). Read it before changing who sees what: the group you need usually exists already. (get portal groups, show client groups)

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": {
      "app_id": "<app_id>",
      "portal_id": "<portal_id>"
    },
    "name": "list_portal_groups"
  }
}

Input Schema

NameRequiredDescriptionDefault
app_idYesProject ID (from list_projects)
portal_idYesPortal ID (from list_portals or describe_project)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so safety is covered. The description adds genuine behavioral context by spelling out what the response contains (members plus each group's role and own-records-only flag) and warning that it should be read before mutating visibility.

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?

The core sentence is dense but front-loaded with the verb and resource, and the guidance sentence follows. The parenthetical keyword list ('get portal groups, show client groups') is search-alias padding rather than information, which is the only real cost.

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?

With no output schema, the description usefully compensates by describing the returned structure. For a two-parameter, read-only listing tool with full annotation coverage, nothing essential is missing; pagination and volume characteristics are the only unstated details.

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%, and both parameters (app_id, portal_id) already document their source tools (list_projects, list_portals/describe_project). The description adds no additional parameter meaning, so the baseline of 3 applies.

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?

Names a specific verb and resource ('list a portal's user groups') and then enumerates the payload precisely: members, per-table/report role, and whether the group sees only its own records. An agent can distinguish this from list_portal_users, list_team_groups, and list_user_roles from the description alone.

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

Usage Guidelines4/5

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

Gives an explicit usage trigger: 'Read it before changing who sees what: the group you need usually exists already.' That is actionable pre-write guidance, though it does not name the alternative tools (create_portal_group, add_user_to_portal_group) it is meant to precede.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources