portkey-admin-mcp

list_user_invites

Read-onlyIdempotent

Retrieve pending and sent user invitations with id, email, role, status, and expiry to check invite state. Requires Enterprise Portkey plan; returns 403 on non-Enterprise plans.

Instructions

List pending and sent invitations with id, email, role, status, and expiry. Use this to check invite state; use list_all_users for users who already accepted. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

TableJSON Schema

Name	Required	Description
`role`	No	Filter invitations by organisation role
`email`	No	Filter by invited email
`status`	No	Filter invitations by lifecycle status
`page_size`	No	Number of results per page (max 100)
`current_page`	No	Zero-based page number; the first page is 0

Output Schema

TableJSON 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 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,}$"

Changed6 schema fields changedv0.11.5Sep 8, 2026

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 invited 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 invitations by organisation role",
+  "enum": [
+    "admin",
+    "member"
+  ],
+  "type": "string"
+}

addedInput schema / properties / status

Added value: +{
+  "description": "Filter invitations by lifecycle status",
+  "enum": [
+    "pending",
+    "cancelled",
+    "accepted",
+    "expired"
+  ],
+  "type": "string"
+}

Changed3 schema fields changedv0.5.0Jul 14, 2026
- 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"
```

Changed2 schema fields changedv0.3.7Jun 12, 2026

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"
+}

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

TDQS

A4.4/5.0

Behavior4/5

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

Annotations already cover safety (readOnlyHint, idempotentHint, destructiveHint=false), so the bar is low; the description still adds real value by disclosing the Enterprise gating and the 403 failure mode. It stops short of describing default page size, sort order, or whether expired invites are included by default.

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 short sentences, each carrying distinct information: what it returns, when to use vs. the alternative, and the plan gate plus error code. Nothing redundant or padded.

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?

Output schema exists, so return-value detail is unnecessary, and the description still names key fields. The safety profile is annotation-covered and the gating is stated, leaving only minor gaps like pagination defaults and sort behavior for a low-complexity read tool.

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% with two enums, so the schema fully documents role, email, status, and pagination. The description enumerates return fields rather than filter semantics and adds no meaning beyond the schema, making the baseline 3 correct.

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 pending and sent invitations') and enumerates the returned fields (id, email, role, status, expiry). It also contrasts itself with list_all_users, so the agent can distinguish it from siblings without opening schemas.

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?

Explicitly tells the agent when to use it ('check invite state') and names the alternative for the other case ('use list_all_users for users who already accepted'). It also surfaces a hard precondition ('Enterprise-gated') that would otherwise only appear as a runtime 403.

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

Deploy Server