portkey-admin-mcp

list_workspace_members

Read-onlyIdempotent

Lists all members in a workspace with roles, status, and timestamps so you can find a user_id for member lookups, updates, or removals.

Instructions

List every member in a workspace with organization role, workspace role, status, and timestamps. Use this to find a user_id before get_workspace_member, update_workspace_member, or remove_workspace_member.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace_id": "<workspace_id>"
    },
    "name": "list_workspace_members"
  }
}

Input Schema

Name	Required	Description
`role`	No	Filter by workspace role
`email`	No	Filter by member email
`page_size`	No	Number of members per page
`current_page`	No	Zero-based page number
`workspace_id`	Yes	The workspace ID to list members for

Output Schema

Name	Required	Description
`ok`	Yes	Whether the tool call succeeded and returned structured data
`data`	No	Structured success payload when ok is true
`error`	No	Structured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.0.11Oct 30, 2026
- addedInput schema / properties / workspace_id / minLength
```
Added value: +1
```

Changed2 schema fields changedv1.0.9Oct 26, 2026

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"

Changed1 schema field changedv0.12.2Oct 2, 2026

changedInput schema / properties / email / pattern

Previous value: -"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"New value: +"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"

Changed4 schema fields changedv0.11.5Sep 8, 2026

addedInput schema / properties / current_page

Added value: +{
+  "description": "Zero-based page number",
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}

addedInput schema / properties / email

Added value: +{
+  "description": "Filter by member 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 / page_size

Added value: +{
+  "description": "Number of members per page",
+  "exclusiveMinimum": 0,
+  "maximum": 100,
+  "type": "integer"
+}

addedInput schema / properties / role

Added value: +{
+  "description": "Filter by workspace role",
+  "enum": [
+    "admin",
+    "manager",
+    "member"
+  ],
+  "type": "string"
+}

Addedv1.0.1May 7, 2026
RemovedMay 1, 2026
First observedJan 1, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already cover readOnly/idempotent/non-destructive, so the bar is lower; the description still adds value by disclosing the shape of the returned member record. It says nothing about pagination behavior or filter semantics, which a listing tool with page_size/current_page should ideally mention.

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?

Two sentences, zero filler, with the capability stated first and the routing hint second. Nothing is repeated from the schema or annotations.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists and annotations carry the safety profile, so the description needn't explain return semantics in depth. The main residual gap is guidance on pagination and using the role/email filters, which matters for a list endpoint that can exceed one page.

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 every parameter (role, email, page_size, current_page, workspace_id) is already documented inline. The description mentions none of the filters or paging, so it adds no semantic meaning beyond the schema, which is the baseline 3.

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?

States a specific verb and resource ('List every member in a workspace') and enumerates the fields returned (organization role, workspace role, status, timestamps). This clearly separates it from get_workspace_member, which targets a single member.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names the follow-up tools (get/update/remove_workspace_member) and the reason to call this one first: to obtain a user_id. It stops short of stating when not to use it (e.g. when you already have an ID and should call get_workspace_member directly) or pointing at list_all_users as an alternative.

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

Deploy Server