Skip to main content
Glama

start_audit_session

Initiate an audit trail for migration sessions, recording before/after values, timing, and errors. Call once at the start of any production migration to log all subsequent changes.

Instructions

Open an audit trail log file for this migration session. All subsequent migrations will be recorded with before/after field values, timing, and error details. Call this once at the start of any production migration.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
output_pathNoWhere to write the audit NDJSON log (default: ./migration-audit.ndjson)
session_idNoHuman-readable session label
Behavior3/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 discloses that it opens a log file and records subsequent migrations, but does not specify side effects like file overwrite behavior, permissions required, or whether it is safe to call multiple times.

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 three sentences, front-loaded with the primary action, followed by what gets recorded, and ends with clear usage guidance. No redundant information.

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 tool's simplicity (2 optional parameters, no output schema, no nested objects), the description covers the purpose, recording behavior, and usage timing adequately. No missing critical information.

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% for both parameters. The tool description adds no additional meaning beyond what the schema already provides, so the baseline of 3 is appropriate.

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 the verb ('Open an audit trail log file') and the resource ('for this migration session'), and distinguishes it from siblings by specifying it is a one-time setup step for production migrations.

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 description explicitly says to call this once at the start of any production migration, providing clear usage context. However, it does not mention when not to use it or any alternatives, though the sibling list includes related but different tools.

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/pinnintisagarSB/ServiceNow-Dev-MCP'

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