Skip to main content
Glama

list_scim_workspace_mappings

Read-onlyIdempotent

Lists SCIM group mappings that grant Portkey workspace roles so you can audit provisioned access or find a mapping ID before deleting it; filter by workspace, group, or role.

Instructions

List identity-provider SCIM group mappings that automatically grant Portkey workspace roles. Use it to audit provisioned access or obtain mapping_id before delete_scim_workspace_mapping; filter by workspace, group, or role and page through large directories. This reads mappings only and does not query individual workspace members. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_scim_workspace_mappings"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoZero-based results page to retrieve; the first page is 0. These SCIM tools name the parameter page, not the current_page used by other list tools.
roleNoReturn only mappings that grant this workspace role
page_sizeNoMappings per page, from 1 through 100
workspace_idNoReturn only mappings for this Portkey workspace UUID (the id from list_workspaces, not its slug)
scim_group_idNoReturn only mappings for this identity-provider SCIM group ID

Output Schema

NameRequiredDescriptionDefault
okYesCall succeeded
dataNoSuccess payload
errorNoFailure details

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.16.5
    • changedOutput schema / properties / data / description
      Previous value: -"Structured success payload when ok is true"New value: +"Success payload"
    • changedOutput schema / properties / error / description
      Previous value: -"Structured error payload when ok is false"New value: +"Failure details"
    • changedOutput schema / properties / error / properties / details / description
      Previous value: -"Optional structured error details"New value: +"Extra error details"
    • changedOutput schema / properties / error / properties / message / description
      Previous value: -"Human-readable error message"New value: +"Error message"
    • changedOutput schema / properties / ok / description
      Previous value: -"Whether the tool call succeeded and returned structured data"New value: +"Call succeeded"
  2. Changed2 schema fields changedv1.0.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Changed1 schema field changedv1.0.8
    • changedInput schema / properties / workspace_id / description
      Previous value: -"Return only mappings for this Portkey workspace ID"New value: +"Return only mappings for this Portkey workspace UUID (the id from list_workspaces, not its slug)"
  4. Changed1 schema field changedv0.11.5
    • changedInput schema / properties / page / description
      Previous value: -"Zero-based results page to retrieve; the first page is 0. Unlike current_page used by other list tools in this API (which is 1-based), do not pass 1 for the first page here."New value: +"Zero-based results page to retrieve; the first page is 0. These SCIM tools name the parameter page, not the current_page used by other list tools."
  5. Changed1 schema field changedv1.0.5
    • changedInput schema / properties / page / description
      Previous value: -"Zero-based results page to retrieve; the first page is 0"New value: +"Zero-based results page to retrieve; the first page is 0. Unlike current_page used by other list tools in this API (which is 1-based), do not pass 1 for the first page here."
  6. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), and the description adds context those annotations cannot express: Enterprise plan gating and a 403 failure mode on non-Enterprise plans. It also signals the pagination expectation for large directories, which shapes how the agent loops over results.

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?

Three sentences, front-loaded with purpose, then routing, then behavioral caveats, with no filler. Each clause carries information an agent would otherwise have to infer from the schema or trial and error.

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?

With an output schema present, the description need not explain return shapes, and it correctly spends its budget on purpose, routing to delete_scim_workspace_mapping, scoping, and plan gating. Nothing an agent needs to call this five-parameter, all-optional list tool correctly is missing.

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 the schema already documents page, page_size, role enum, workspace_id UUID semantics, and scim_group_id, including the page-vs-current_page naming quirk. The description only restates the filtering axes (workspace, group, role), 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?

The first sentence gives a specific verb and resource ("List identity-provider SCIM group mappings") plus the functional consequence ("that automatically grant Portkey workspace roles"). It also explicitly separates itself from the member-listing siblings by stating it "does not query individual workspace members."

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?

Names two concrete use cases ("audit provisioned access" and "obtain mapping_id before delete_scim_workspace_mapping"), which routes the agent to the correct follow-up tool. The explicit exclusion of individual member queries plus the Enterprise-gating note tells the agent when this tool will not be the right or available call.

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

Deploy Server

Other Tools