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, settings, and timestamps to locate a workspace_id for get, update, or membership operations. Filter by name or status.

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

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

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. 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"
+}
  3. 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"
  4. 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
  5. Addedv1.0.1
  6. Removed
  7. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, openWorld and non-destructive, so the safety profile is covered. The description adds the returned field inventory (id, name, slug, defaults, timestamps), but says nothing about ordering, pagination defaults, or volume of results.

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, each earning its place: first the output contents, then the workflow use case, both front-loaded with no filler.

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?

With annotations, a full-coverage schema and an output schema, the description only needs purpose and workflow context, which it supplies. Slightly short of complete because it never hints at pagination or result-set size behavior for an open-world list call.

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 five fully documented filter/pagination params, so the schema carries the burden. The description mentions no filtering or paging semantics, adding nothing beyond the baseline.

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 (List) and resource (workspaces) plus the returned fields, distinguishing it clearly from get_workspace and the list_workspace_members sibling.

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_workspace, update_workspace, add_workspace_member, remove_workspace_member) that need a workspace_id, which is actionable routing guidance. It lacks an explicit when-not-to-use note (e.g. preferring get_workspace when the id is already known), so not a 5.

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