Skip to main content
Glama

list_usage_limit_entities

Read-onlyIdempotent

List tracked values and current usage for a usage-limit policy, with filters for active or exhausted state, search, and pagination to identify 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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "limit_id": "<limit_id>"
    },
    "name": "list_usage_limit_entities"
  }
}

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
okYesCall succeeded
dataNoSuccess payload
errorNoFailure details

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.16.5
    • changedOutput schema / properties / data / description
      Previous value: -"Structured success payload when ok is true"New value: +"Success payload"
    • changedOutput schema / properties / error / description
      Previous value: -"Structured error payload when ok is false"New value: +"Failure details"
    • changedOutput schema / properties / error / properties / details / description
      Previous value: -"Optional structured error details"New value: +"Extra error details"
    • changedOutput schema / properties / error / properties / message / description
      Previous value: -"Human-readable error message"New value: +"Error message"
    • changedOutput schema / properties / ok / description
      Previous value: -"Whether the tool call succeeded and returned structured data"New value: +"Call succeeded"
  2. 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"
  3. 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"
      +}
  4. Addedv1.0.1

TDQS

A4.2/5.0
Behavior4/5

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

The annotations already establish that this is a safe, read-only, idempotent, non-destructive operation. The description adds useful behavioral context by saying it returns each tracked value key with current usage and supports filtering by enforcement state, search text, and pagination.

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?

The description is two compact sentences with the primary purpose front-loaded. It mentions the returned fields, filters, pagination, and reset workflow without unnecessary wording.

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?

For a paginated list tool with a full input schema and output schema, the description covers the essential purpose, filters, and workflow context. It could be slightly more complete by naming the reset sibling explicitly, but the current information is sufficient for correct selection and invocation.

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 coverage is 100%, so the meaning of limit_id, status, search, page_size, and current_page is already documented in the input schema. The description reinforces the filtering and pagination purpose but does not add syntax or constraints beyond what the schema already provides.

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 and resource: list values currently tracked by one usage-limit policy. It also clarifies that each returned item includes a value key and current usage, which distinguishes it from policy-level siblings such as get_usage_limit.

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 phrase 'before resetting one counter' gives a clear operational context: use this to inspect entities before calling a reset tool. It does not explicitly name reset_usage_limit_entity or state when not to use this tool, but the intended workflow is clear.

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