Skip to main content
Glama
Sign In
portkey-admin-mcp

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_scim_groups

Read-onlyIdempotent

Search and page through SCIM groups synchronized to Portkey to resolve a group ID or exact display name before creating workspace mappings; returns 403 on non-Enterprise plans.

Instructions

Search and page through identity-provider groups synchronized to Portkey over SCIM. Use this to resolve a group ID or exact display name before create_scim_workspace_mapping; it reads directory groups only and does not show their workspace mappings or individual 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_groups"
  }
}

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.
searchNoCase-insensitive text to match against SCIM group names
page_sizeNoSCIM groups per page, from 1 through 100

Output Schema

NameRequiredDescriptionDefault
okYesWhether the tool call succeeded and returned structured data
dataNoStructured success payload when ok is true
errorNoStructured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
  2. 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."
  3. 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."
  4. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the description wisely spends its words elsewhere: Enterprise plan gating and the concrete failure mode '403 on non-Enterprise Portkey plans'. Pagination behavior and result shape are left to the schema/output schema, but the plan-gating precondition is the key operational fact and it is stated.

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?

Three sentences, front-loaded with purpose then usage then constraint. Slight redundancy between 'Enterprise-gated' and 'Returns 403 on non-Enterprise Portkey plans' – the second sentence alone would carry the fact – but nothing is filler.

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 and full schema-level parameter docs, the description covers the remaining unknowns: scope, sequencing relative to the mapping tool, plan prerequisite, and error behavior. Nothing essential to a correct call 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 even documents the page/current_page naming quirk, so the description does not need to restate parameter semantics. 'Page through' only loosely aligns with the page and page_size params; baseline 3 is appropriate.

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?

Specific verb and resource: 'Search and page through identity-provider groups synchronized to Portkey over SCIM.' It immediately disambiguates from list_scim_workspace_mappings and list_all_users by naming what is read (directory groups) and what is excluded (workspace mappings, 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?

Gives an explicit trigger – 'Use this to resolve a group ID or exact display name before create_scim_workspace_mapping' – plus a negative scope statement ('reads directory groups only and does not show their workspace mappings or individual members'), which routes the agent away from the mapping tool.

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