Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_analytics_group_workspaces

Read-onlyIdempotent

Retrieve a paginated per-workspace analytics breakdown of request counts, costs, and group totals to support org-wide chargeback and workspace comparisons.

Instructions

Get a paginated per-workspace breakdown with total_groups, group_count, is_quota_exceeded when reported, and a workspaces array containing each workspace_slug with request count and cost. Use this for org-wide chargeback or comparing workspaces; pass workspace_slug to other analytics tools to drill into one workspace. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

NameRequiredDescriptionDefault
configsNoLegacy Portkey query param for config slugs. Comma-separated string; prefer config_slugs for structured inputs.
span_idNoLegacy Portkey query param for span IDs. Comma-separated string; prefer span_ids for structured inputs.
cost_maxNoMaximum cost in cents to filter by
cost_minNoMinimum cost in cents to filter by
metadataNoLegacy Portkey query param for metadata filtering. Stringified JSON object, e.g. '{"env":"prod","app":"myapp"}'; prefer metadata_filter for structured inputs.
span_idsNoStructured alias for span_id. Use an array of span IDs; normalized to the legacy comma-separated Portkey query param.
trace_idNoLegacy Portkey query param for trace IDs. Comma-separated string; prefer trace_ids for structured inputs.
page_sizeNoResults per page (max 100)
trace_idsNoStructured alias for trace_id. Use an array of trace IDs; normalized to the legacy comma-separated Portkey query param.
api_key_idsNoLegacy Portkey query param for API key UUIDs. Comma-separated string; request_analytics also accepts an array and normalizes it to this form.
prompt_slugNoFilter by prompt slug
status_codeNoLegacy Portkey query param for HTTP status codes. Comma-separated string; prefer status_codes for structured inputs.
ai_org_modelNoLegacy Portkey query param for provider/model pairs. Format: 'provider__model' with double underscore, e.g. 'openai__gpt-4' or 'anthropic__claude-3-opus'. Comma-separated string; prefer provider_models for structured inputs.
config_slugsNoStructured alias for configs. Use an array of config slugs; normalized to the legacy comma-separated Portkey query param.
current_pageNoZero-based page number; the first page is 0
status_codesNoStructured alias for status_code. Use an array of HTTP status codes; normalized to the legacy comma-separated Portkey query param.
virtual_keysNoLegacy Portkey query param for virtual key slugs. Comma-separated string; prefer virtual_key_slugs for structured inputs.
deployment_idNoComma-separated list of deployment IDs (UUIDs) to filter by. Prefer deployment_ids for structured inputs.
deployment_idsNoStructured alias for deployment_id. Use an array of deployment UUIDs; normalized to the comma-separated Portkey query param.
workspace_slugNoFilter by one workspace. Takes precedence over include_all_workspaces and exclude_workspace_slugs when provided.
metadata_filterNoStructured alias for metadata. Use an object such as { env: 'prod' }; normalized to a JSON string before the request is sent.
provider_modelsNoStructured alias for ai_org_model. Use provider__model strings in an array; normalized to the legacy comma-separated Portkey query param.
total_units_maxNoMaximum number of total tokens to filter by
total_units_minNoMinimum number of total tokens to filter by
prompt_token_maxNoMaximum number of prompt tokens
prompt_token_minNoMinimum number of prompt tokens
virtual_key_slugsNoStructured alias for virtual_keys. Use an array of virtual key slugs; normalized to the legacy comma-separated Portkey query param.
completion_token_maxNoMaximum number of completion tokens
completion_token_minNoMinimum number of completion tokens
weighted_feedback_maxNoMaximum weighted feedback score (-10 to 10)
weighted_feedback_minNoMinimum weighted feedback score (-10 to 10)
include_all_workspacesNoAggregate across all organisation workspaces with an organisation API key. Ignored for workspace API keys or when workspace_slug is provided. Supply workspace_slug, include_all_workspaces=true, or exclude_workspace_slugs to choose a scope.
time_of_generation_maxYesEnd time for the analytics period (ISO8601 format, e.g., '2024-02-01T00:00:00Z')
time_of_generation_minYesStart time for the analytics period (ISO8601 format, e.g., '2024-01-01T00:00:00Z')
exclude_workspace_slugsNoComma-separated workspace slugs to exclude from organisation-wide analytics, for example ws-legacy,ws-archived. Only applies to organisation API keys; workspace_slug takes precedence.

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. Changed5 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"
    • addedInput schema / properties / exclude_workspace_slugs
      Added value: +{
+  "description": "Comma-separated workspace slugs to exclude from organisation-wide analytics, for example ws-legacy,ws-archived. Only applies to organisation API keys; workspace_slug takes precedence.",
+  "minLength": 1,
+  "type": "string"
+}
    • addedInput schema / properties / include_all_workspaces
      Added value: +{
+  "description": "Aggregate across all organisation workspaces with an organisation API key. Ignored for workspace API keys or when workspace_slug is provided. Supply workspace_slug, include_all_workspaces=true, or exclude_workspace_slugs to choose a scope.",
+  "type": "boolean"
+}
    • changedInput schema / properties / workspace_slug / description
      Previous value: -"Filter by specific workspace"New value: +"Filter by one workspace. Takes precedence over include_all_workspaces and exclude_workspace_slugs when provided."
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Addedv0.13.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds what annotations cannot: pagination semantics, Enterprise gating, and a concrete 403 failure mode for non-Enterprise plans. It also flags that is_quota_exceeded is only present 'when reported', a useful conditional-field caveat.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three dense sentences, front-loaded with the capability then usage then the gating caveat. Some of the response-field enumeration duplicates the output schema, but it is compact and every sentence contributes.

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?

Covers purpose, scope, gating, and failure behavior for a 35-parameter paginated analytics tool with an existing output schema. An agent has enough to select and call it correctly; only the sibling-tool naming and aggregation-scope precedence (include_all_workspaces vs workspace_slug) are left to the schema.

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 35 parameters are already documented; the description adds nothing beyond a hint that workspace_slug drills into a single workspace. Baseline 3 is appropriate since the schema carries the full parameter burden.

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 (per-workspace breakdown) and enumerates the returned metrics (total_groups, group_count, is_quota_exceeded, workspaces array). This clearly separates it from the sibling group tools (group_users, group_models, group_providers, group_metadata) that share the same analytics family.

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 use cases (org-wide chargeback, comparing workspaces) and points to the follow-up path via workspace_slug on other analytics tools. It stops short of naming which sibling group tool to use for the alternative breakdowns, so the routing is directional rather than precise.

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