Skip to main content
Glama

list_audit_logs

Read-onlyIdempotent

Retrieve paginated audit log events for your Portkey workspace or organization. Filter by actor, action, resource, or time range to review individual events for compliance and incident investigation.

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
workspace_idNoFilter audit logs by workspace ID
actor_idNoFilter by the user ID who performed the action
actionNoFilter by action type (e.g., 'create', 'update', 'delete', 'login')
resource_typeNoFilter by resource type (e.g., 'user', 'workspace', 'config', 'virtual_key')
resource_idNoFilter by specific resource ID
start_timeNoStart of time range filter (ISO 8601 format, e.g., '2024-01-01T00:00:00Z')
end_timeNoEnd of time range filter (ISO 8601 format, e.g., '2024-01-31T23:59:59Z')
current_pageNoPage number for pagination (starts at 1)
page_sizeNoNumber of results per page (max 100)

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
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint, idempotentHint, openWorldHint. Description adds context about response structure and enterprise restriction, but does not detail rate limits or other constraints.

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 efficient sentences with no redundancy. Purpose, output, usage, and warning are front-loaded and concise.

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?

With output schema present, description covers purpose, output types, usage distinction, and error condition. All essential information is provided for a paginated list tool.

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?

All 9 parameters have full descriptions in the schema (100% coverage), so baseline 3. Description does not add new parameter semantics beyond mentioning pagination.

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?

Description clearly states verb 'List', resource 'audit log events', scope 'workspace or organization', and specifies return type 'paginated action-level records with actor, resource, metadata, and timestamps'. It also distinguishes from analytics tools.

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?

Explicitly advises using this tool for individual events instead of analytics aggregates, and warns about enterprise gating with a 403 error on non-Enterprise plans.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/s-b-e-n-s-o-n/portkey-admin-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server