list_scim_workspace_mappings

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

Annotations already cover readOnly/idempotent/non-destructive, and the description adds meaningful context beyond them: the operation is scoped to mappings only ('does not query individual workspace members'), it supports paging through large directories, and crucially it discloses an entitlement gate ('Enterprise-gated. Returns 403 on non-Enterprise Portkey plans'). Disclosing the auth requirement and the specific failure mode is exactly the behavioral information an agent needs before invoking.

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?

Four sentences, each earning its place: purpose, use cases plus related-tool reference, behavioral scope, and error/entitlement behavior. The core purpose is front-loaded in the first sentence, and there is zero redundant restating of the title or the schema content.

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 filtered list tool with 5 optional params, full schema coverage, an output schema, and safety annotations covering read-only/idempotency, the description covers every decision-relevant gap: purpose, use cases, workflow linkage to delete_scim_workspace_mapping, pagination, entitlement gating, and the 403 failure mode. Nothing an agent needs to decide whether to call this tool is missing.

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?

Schema description coverage is 100% and every parameter (page, role, page_size, workspace_id, scim_group_id) already has a thorough schema description, including a disambiguation note about the page parameter naming. The description adds only a light grouping ('filter by workspace, group, or role and page through large directories') that maps to the schema. With the schema doing the heavy lifting, the baseline 3 applies.

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 opens with a specific verb and resource: 'List identity-provider SCIM group mappings that automatically grant Portkey workspace roles.' The qualifier 'automatically grant... roles' distinguishes this from the sibling list_scim_groups (which lists groups, not mappings) and from list_workspace_members, reinforced later by 'does not query individual workspace members.' An agent can identify exactly what this tool does without opening the schema.

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?

Explicit use cases are given: 'Use it to audit provisioned access or obtain mapping_id before delete_scim_workspace_mapping,' which names a concrete workflow and a sibling tool. It also states an explicit exclusion ('does not query individual workspace members') so an agent knows not to use it for member lookups, and it prescribes filter/pagination parameters. This is the strongest form of usage guidance.

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