create_scim_workspace_mapping

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

The description goes beyond annotations by disclosing that this changes access provisioning, that a group name can pre-create a Portkey SCIM group, and that non-Enterprise plans return 403. It does not contradict the annotations, though it could add more on duplicate-mapping behavior or idempotency.

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?

The description is front-loaded around the core mapping action, then follows with parameter selection, discovery helpers, sibling distinction, and Enterprise gating. Every sentence adds useful routing or behavioral information without unnecessary restatement.

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?

Given the rich schema, existing output schema, and annotations, the description supplies the routing, selection rules, side effect, and plan gating an agent needs. Return values need not be explained because an output schema exists.

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%, so the baseline is 3, but the description adds meaningful semantics by emphasizing exactly-one selection between scim_group_id and scim_group_name and explaining the pre-creation effect of using a name. The workspace_id and role meanings remain mostly schema-driven.

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?

States the specific action clearly: map one identity-provider SCIM group to a Portkey workspace role so members receive access automatically. It names the sibling alternative add_workspace_member and distinguishes itself from that tool, so an agent can select correctly without opening another 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?

Provides explicit selection rules: use exactly one of scim_group_id or scim_group_name, use list_scim_groups to discover groups, and use list_workspaces to obtain the workspace ID. It also states when this differs from add_workspace_member and adds the Enterprise-plan precondition.

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