Skip to main content
Glama

get-audit-logs

Retrieve audit events from Miro to monitor user activities, track changes, and ensure compliance within enterprise environments.

Instructions

Retrieves a page of audit events from the last 90 days (Enterprise only)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
createdAfterYesRetrieve audit logs created after this date (ISO 8601 format)
createdBeforeYesRetrieve audit logs created before this date (ISO 8601 format)
cursorNoCursor for pagination
limitNoMaximum number of results to return (default: 100)
sortingNoSort order for results (default: ASC)

Implementation Reference

  • The handler function that executes the tool's core logic: constructs a query from parameters and calls MiroClient.getApi().enterpriseGetAuditLogs to fetch audit logs.
    fn: async ({ createdAfter, createdBefore, cursor, limit, sorting }) => {
      try {
        const query: any = {};
        if (cursor) query.cursor = cursor;
        if (limit) query.limit = limit;
        if (sorting) query.sorting = sorting;
    
        const response = await MiroClient.getApi().enterpriseGetAuditLogs(
          createdAfter,
          createdBefore,
          query
        );
    
        return ServerResponse.text(JSON.stringify(response.body, null, 2));
      } catch (error) {
        process.stderr.write(`Error retrieving audit logs: ${error}\n`);
        return ServerResponse.error(error);
      }
    }
  • Zod schema defining the input parameters for the get-audit-logs tool, including descriptions.
    args: {
      createdAfter: z.string().describe("Retrieve audit logs created after this date (ISO 8601 format)"),
      createdBefore: z.string().describe("Retrieve audit logs created before this date (ISO 8601 format)"),
      cursor: z.string().optional().nullish().describe("Cursor for pagination"),
      limit: z.number().optional().nullish().describe("Maximum number of results to return (default: 100)"),
      sorting: z.enum(["ASC", "DESC"]).optional().nullish().describe("Sort order for results (default: ASC)")
    },
  • src/index.ts:195-195 (registration)
    Registers the get-audit-logs tool (imported as getAuditLogsTool) with the ToolBootstrapper instance.
    .register(getAuditLogsTool)
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It mentions 'a page' (implying pagination) and 'Enterprise only' (implying access restrictions), but doesn't disclose other behavioral traits like rate limits, authentication needs, response format, or what happens with invalid parameters. For a read operation with no annotation coverage, this leaves significant gaps.

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 a single, efficient sentence with zero waste. It's front-loaded with the core action ('retrieves a page of audit events') and includes key constraints ('from the last 90 days', 'Enterprise only') without unnecessary elaboration.

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?

Given no annotations, no output schema, and a read operation with 5 parameters, the description is minimally complete. It covers the basic purpose and scope but lacks details on behavioral aspects (e.g., error handling, pagination mechanics) and output format, which are important for a tool with multiple parameters and no structured output documentation.

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%, so the schema already documents all parameters (e.g., 'createdAfter' for ISO 8601 dates, 'cursor' for pagination). The description adds no additional parameter semantics beyond what's in the schema, such as default values for 'limit' or 'sorting', which are already covered. Baseline 3 is appropriate when the schema does the heavy lifting.

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?

The description clearly states the verb ('retrieves') and resource ('audit events'), specifying it's 'a page' and from 'the last 90 days'. However, it doesn't distinguish this tool from other 'get-' siblings like 'get-board-content-logs' or 'get-legal-hold-content-items', which also retrieve logs but for different resources.

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 description implies usage by mentioning 'Enterprise only', suggesting it's for enterprise-level audit logs, but doesn't explicitly state when to use this versus other log-related tools (e.g., 'get-board-content-logs') or provide alternatives. The context is clear but lacks explicit guidance on exclusions or comparisons.

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/k-jarzyna/mcp-miro'

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