Skip to main content
Glama

list_audit_logs

Read-onlyIdempotent

Retrieve paginated audit log events for a Portkey workspace or organization, including actor, resource, metadata, and timestamps for compliance or incident review. Use this when individual action records are needed, not aggregates.

Instructions

List audit log events for a Portkey workspace or organization. Returns paginated action-level records with actor, resource, metadata, and timestamps for compliance or incident review; use this instead of analytics when you need individual events, not aggregates. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionNoFilter by action type (e.g., 'create', 'update', 'delete', 'login')
actor_idNoFilter by the user ID who performed the action
end_timeNoEnd of time range filter (ISO 8601 format, e.g., '2024-01-31T23:59:59Z')
page_sizeNoNumber of results per page (max 100)
start_timeNoStart of time range filter (ISO 8601 format, e.g., '2024-01-01T00:00:00Z')
resource_idNoFilter by specific resource ID
current_pageNoZero-based page number; the first page is 0
workspace_idNoFilter audit logs by workspace ID
resource_typeNoFilter by resource type (e.g., 'user', 'workspace', 'config', 'virtual_key')

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. Changed3 schema fields changedv0.11.5
    • changedInput schema / properties / current_page / description
      Previous value: -"Page number for pagination (starts at 1)"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
  2. 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"
  3. Addedv1.0.1
  4. Removed
  5. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive behavior, so the bar is lower. The description adds useful behavioral context: results are paginated, records include actor/resource/metadata/timestamps, and the Enterprise plan requirement is disclosed. This goes beyond the schema and annotations without contradicting them.

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?

Three sentences, each earning its place: the first states the core purpose and output shape, the second differentiates from analytics, and the third flags the enterprise restriction. No filler or redundant restating of the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the output schema exists and the input schema is fully self-documenting, the description covers the key non-obvious aspects: individual vs aggregate data, pagination, and enterprise entitlement. Nothing essential for correct selection or invocation is missing.

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 all parameters have meaningful descriptions. The tool description does not need to add parameter-level detail, and it does not. It does imply pagination and time-range use, but the schema already handles each parameter clearly.

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 clearly states a specific verb and resource: 'List audit log events for a Portkey workspace or organization.' It also distinguishes the tool from analytics by emphasizing it returns individual action-level events rather than aggregates, which separates it from many similar list/analytics siblings.

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

Usage Guidelines5/5

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

The description gives explicit when-to-use guidance: 'use this instead of analytics when you need individual events, not aggregates.' It also provides an important exclusion by noting the tool is Enterprise-gated and returns 403 on non-Enterprise plans, helping the agent decide whether to attempt the call.

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