Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_all_users

Read-onlyIdempotent

List accepted organization users with id, name, email, role, and timestamps. Use to locate a user_id before updating, deleting, or adding workspace members.

Instructions

List accepted org users with id, name, email, role, and timestamps. Use this to find a user_id before get_user, update_user, delete_user, or add_workspace_member; use list_user_invites for pending invitations. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roleNoFilter by organisation role
emailNoFilter by exact email
page_sizeNoNumber of results per page (max 100)
current_pageNoZero-based page number; the first page is 0

Output Schema

TableJSON 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. Changed5 schema fields changedv0.11.5
    • changedInput schema / properties / current_page / description
      Previous value: -"Page number for pagination"New value: +"Zero-based page number; the first page is 0"
    • removedInput schema / properties / current_page / exclusiveMinimum
      Removed value: -0
    • addedInput schema / properties / current_page / minimum
      Added value: +0
    • addedInput schema / properties / email
      Added value: +{
+  "description": "Filter by exact email",
+  "format": "email",
+  "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
+  "type": "string"
+}
    • addedInput schema / properties / role
      Added value: +{
+  "description": "Filter by organisation role",
+  "enum": [
+    "admin",
+    "member",
+    "owner"
+  ],
+  "type": "string"
+}
  2. Changed3 schema fields changedv0.5.0
    • addedInput schema / properties / current_page / maximum
      Added value: +9007199254740991
    • changedInput schema / properties / current_page / type
      Previous value: -"number"New value: +"integer"
    • changedInput schema / properties / page_size / type
      Previous value: -"number"New value: +"integer"
  3. Changed2 schema fields changedv0.3.7
    • addedInput schema / properties / current_page
      Added value: +{
+  "description": "Page number for pagination",
+  "exclusiveMinimum": 0,
+  "type": "number"
+}
    • addedInput schema / properties / page_size
      Added value: +{
+  "description": "Number of results per page (max 100)",
+  "exclusiveMinimum": 0,
+  "maximum": 100,
+  "type": "number"
+}
  4. Addedv1.0.1
  5. Removed
  6. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations (readOnly, idempotent, non-destructive), the description discloses that this returns only accepted users, that it is Enterprise-gated, and that it returns a 403 on non-Enterprise plans. This adds meaningful operational context that the agent cannot infer from the annotations or schema alone.

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 tight sentences: the first defines the tool's output, the second provides routing guidance, and the third warns about the enterprise restriction. Every sentence earns its place, and the critical information is front-loaded.

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?

The tool is simple, has full schema coverage, an output schema, and annotations that clarify safety and idempotency. The description supplies the missing context around accepted status, expected usage, and enterprise gating, making it complete for an agent to select and invoke correctly.

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%, so the schema already documents all four parameters fully. The description does not add extra nuance about how role, email, page_size, or current_page behave beyond what the schema states, so the baseline score of 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?

The description states a specific verb ('List'), a clear resource ('accepted org users'), and the exact fields returned (id, name, email, role, timestamps). It also distinguishes itself from list_user_invites by explicitly noting that pending invitations are not included, so an agent can confidently tell this tool apart from similar list operations.

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?

The description gives explicit when-to-use guidance: use this tool to find a user_id before calling get_user, update_user, delete_user, or add_workspace_member. It also names the alternative for pending invites (list_user_invites), which directly addresses a common point of confusion.

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