Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_workspaces

Read-onlyIdempotent

Retrieve workspaces with IDs, names, slugs, default settings, and timestamps, filtered by name or status, to find the workspace_id required for updating workspace settings or managing members.

Instructions

List workspaces with id, name, slug, default settings, and timestamps. Use this to find a workspace_id before get_workspace, update_workspace, add_workspace_member, or remove_workspace_member.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoCase-sensitive name filter
statusNoFilter by workspace lifecycle status
page_sizeNoNumber of workspaces to return per page (max 100)
exact_nameNoExact workspace name filter
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. Changed6 schema fields changedv0.11.5
    • changedInput schema / properties / current_page / description
      Previous value: -"Page number to retrieve when results are paginated"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 / exact_name
      Added value: +{
+  "description": "Exact workspace name filter",
+  "type": "string"
+}
    • addedInput schema / properties / name
      Added value: +{
+  "description": "Case-sensitive name filter",
+  "type": "string"
+}
    • addedInput schema / properties / status
      Added value: +{
+  "description": "Filter by workspace lifecycle status",
+  "enum": [
+    "active",
+    "archived"
+  ],
+  "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 changedv1.0.2
    • changedInput schema / properties / page_size / description
      Previous value: -"Number of workspaces to return per page (default varies by endpoint)"New value: +"Number of workspaces to return per page (max 100)"
    • addedInput schema / properties / page_size / maximum
      Added value: +100
  4. Addedv1.0.1
  5. Removed
  6. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is fully covered. The description adds the returned-field context and positions the tool as a lookup step, but does not disclose additional behavior such as default page size or ordering. With annotations covering the risk profile, a 3 is appropriate.

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. The first sentence states the core behavior and output fields; the second provides routing value by naming the dependent operations. Everything earns its place and the key 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?

With an output schema present, rich annotations covering safety, and full parameter documentation, the description only needed to establish purpose and usage context — both are present. Nothing an agent needs to select and invoke this 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%, so all five parameters (name, status, page_size, exact_name, current_page) are already fully documented with types, bounds, enum values, and semantics. The description adds no parameter-level detail, but the schema carries the burden effectively, so the baseline 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 description states a specific verb ('List') plus resource ('workspaces') and enumerates the returned fields (id, name, slug, default settings, timestamps). It also names the exact downstream operations it feeds (get_workspace, update_workspace, add_workspace_member, remove_workspace_member), making it easy to distinguish from siblings like list_workspace_members or list_scim_workspace_mappings.

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?

Gives explicit, actionable context: 'Use this to find a workspace_id before' four named operations. This tells the agent exactly when to reach for this tool. It stops short of a full 5 because it doesn't state when not to use it or name alternative lookup tools, but the provided workflow guidance is concrete and sufficient.

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