invoke_action

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

No annotations were provided. The description adds context by noting the required environment variable (ACUMATICA_ALLOW_WRITES=1) and explaining HTTP return codes (204 for fire-and-forget, 202 for long-running). However, it does not detail potential side effects, error handling, or reversibility.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise yet thorough: one sentence for purpose, code examples, then structured argument descriptions. No wasted words, and information is front-loaded.

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

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

Given the presence of an output schema (not shown) and the complexity of 4 parameters (2 required, 2 optional objects), the description covers purpose, parameters, environment requirement, and return values. It could mention error cases or idempotency but is largely complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description carries full burden. It explains each parameter: entity (entity name), action (use describe_entity to list), entity_record (wrapped format with example), parameters (action-specific). This adds substantial meaning beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Invoke a named action on an entity' and provides concrete examples (CancelSalesOrder, ReleaseBill), making the purpose unambiguous and distinct from sibling tools like upsert_record or delete_record.

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

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

The description explains when to use this tool (invoking actions), mentions using describe_entity to find available actions, and includes examples. It does not explicitly compare to siblings or state when not to use, but the guidance is clear enough for most cases.

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