Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_usage_limit_entities

Read-onlyIdempotent

List tracked values for a usage-limit policy, showing each key and current usage. Filter by active or exhausted state, search text, and paginate to pinpoint counters before resetting.

Instructions

List the values currently tracked by one usage-limit policy with each value key and current usage. Filter by active or exhausted state, search text, and pagination before resetting one counter.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
searchNoSearch tracked values
statusNoFilter by enforcement state
limit_idYesUsage-limit policy UUID
page_sizeNoNumber of entities per page
current_pageNoZero-based page number

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
    • addedInput schema / properties / current_page
      Added value: +{
+  "description": "Zero-based page number",
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}
    • changedInput schema / properties / limit_id / description
      Previous value: -"Usage limit policy ID"New value: +"Usage-limit policy UUID"
    • addedInput schema / properties / limit_id / minLength
      Added value: +1
    • addedInput schema / properties / page_size
      Added value: +{
+  "description": "Number of entities per page",
+  "exclusiveMinimum": 0,
+  "maximum": 100,
+  "type": "integer"
+}
    • addedInput schema / properties / search
      Added value: +{
+  "description": "Search tracked values",
+  "type": "string"
+}
    • addedInput schema / properties / status
      Added value: +{
+  "description": "Filter by enforcement state",
+  "enum": [
+    "active",
+    "exhausted"
+  ],
+  "type": "string"
+}
  2. Addedv1.0.1

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, fully covering the safety profile, so the bar is lower. The description adds modest context: per-policy scoping, the return contents (value keys + current usage), and a workflow cue, but reveals no deeper behavior such as pagination defaults or open-world state effects beyond what annotations already signal.

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 front-loaded sentences with zero filler: the first states the action, resource, and return content; the second enumerates filters and the workflow position. Every clause earns its place, and the most important disambiguator ('one usage-limit policy') appears immediately.

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?

Given rich annotations, 100% schema coverage, and a present output schema, the description supplies the essential selection and invocation context: required limit_id is implied by 'one usage-limit policy', and filters are enumerated. Explicit alternative routing (e.g., naming list_usage_limits) and pagination defaults are minor gaps partially covered by sibling names and 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% — all five parameters (search, status, limit_id, page_size, current_page) carry meaningful descriptions such as 'Filter by enforcement state' and 'Zero-based page number'. The description merely echoes the filter set (status, search, pagination) without adding syntax or format details, so the high-coverage baseline of 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 opens with a specific verb and resource: 'List the values currently tracked by one usage-limit policy', and states what is returned ('each value key and current usage'). Scoping to a single policy distinguishes it from the sibling `list_usage_limits` (which lists policies) and positions it relative to `reset_usage_limit_entity`. The purpose is unmistakable.

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?

The description gives clear operational context: it is for inspecting the tracked values of one policy, with filters for active/exhausted state, search text, and pagination, and it is positioned before a reset action ('before resetting one counter'). It stops short of explicitly naming alternatives or stating when-not-to-use, relying on inference to separate it from list_usage_limits/get_usage_limit.

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