Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

list_usage_limit_entities

Read-onlyIdempotent

List the tracked values of a usage-limit policy with current usage, filtering by active or exhausted state, search text, and pagination before resetting a counter.

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

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

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
    • 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"
+}
  3. Addedv1.0.1

TDQS

A3.5/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 usefully adds that results carry a value key and current usage and that 'state' means enforcement state (active/exhausted), but says nothing about ordering or result volume.

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?

A single front-loaded sentence identifies the resource and the payload, then lists the filters. Dense but no filler sentences; nothing is buried.

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 full schema coverage, complete annotations and an output schema, the description only needs to frame scope and it does. Minor residual gaps (result ordering, when to prefer this over get_usage_limit) keep it off a 5.

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% and every parameter is already documented, so the baseline is 3. The description confirms the filter axes (state, search text, pagination) but adds no semantics beyond the schema, such as whether search is substring or exact.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: lists the values (entities) tracked by one usage-limit policy, plus the payload shape (value key + current usage). This clearly separates it from list_usage_limits (policies, not entities) and get_usage_limit, though it does not say so outright.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The trailing clause 'before resetting one counter' implies the intended workflow, but the alternative (reset_usage_limit_entity) is never named and no when-not-to-use condition is given. Usage is suggested rather than spelled out.

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