Skip to main content
Glama

get_acl_audit

Retrieve ACL audit logs to investigate connection failures and audit access patterns by filtering username, reason, or time range.

Instructions

Get persisted ACL audit log entries from storage. Filter by username, reason (auth, command, key, channel), or time range. Use this to investigate why a connection is failing or audit access patterns.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
usernameNoFilter by username
reasonNoFilter by reason (auth, command, key, channel)
startTimeNoStart time (Unix timestamp ms)
endTimeNoEnd time (Unix timestamp ms)
limitNoMax entries to return
instanceIdNoOptional instance ID override

Implementation Reference

  • The handler function for 'get_acl_audit' which fetches the ACL audit log data from the API based on provided query parameters.
    async ({ username, reason, startTime, endTime, limit, instanceId }) => {
      const id = resolveInstanceId(instanceId);
      const qs = buildQuery({ username, reason, startTime, endTime, limit });
      const data = await apiFetch(`/mcp/instance/${id}/audit${qs}`);
      return {
        content: [{ type: 'text' as const, text: JSON.stringify(data, null, 2) }],
      };
    },
  • The registration of the 'get_acl_audit' tool using server.tool, including the definition of its schema/arguments.
    server.tool(
      'get_acl_audit',
      'Get persisted ACL audit log entries from storage. Filter by username, reason (auth, command, key, channel), or time range. Use this to investigate why a connection is failing or audit access patterns.',
      {
        username: z.string().optional().describe('Filter by username'),
        reason: z.string().optional().describe('Filter by reason (auth, command, key, channel)'),
        startTime: z.number().optional().describe('Start time (Unix timestamp ms)'),
        endTime: z.number().optional().describe('End time (Unix timestamp ms)'),
        limit: z.number().optional().describe('Max entries to return'),
        instanceId: z.string().optional().describe('Optional instance ID override'),
      },
Behavior3/5

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

No annotations provided, so description carries full burden. Mentions 'persisted... from storage' indicating data persistence, but omits performance characteristics, volume limits, or output structure details that would help an agent understand operational implications.

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 well-structured sentences totaling ~30 words: purpose, filter capabilities, and use cases. Zero redundancy, front-loaded with the core action.

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

Completeness3/5

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

Input parameters are fully documented via schema, but missing output schema means the description should ideally describe return format/fields. Stops short of explaining what an 'ACL audit log entry' contains.

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 has 100% description coverage, establishing baseline 3. Description maps 'time range' to startTime/endTime parameters conceptually, but mostly repeats schema descriptions without adding syntax details or format examples (e.g., Unix timestamp clarification for time fields).

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 specific verb 'Get' and resource 'ACL audit log entries from storage'. Clearly distinguishes from siblings like get_commandlog and get_slowlog by specifying 'ACL audit' focus, though it doesn't explicitly contrast with them.

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?

Provides tactical use cases ('investigate why a connection is failing or audit access patterns'), but lacks explicit when-not-to-use guidance or comparison to alternatives like get_client_activity for connection debugging.

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/BetterDB-inc/monitor'

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