sn_script

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

With no annotations, the description carries the transparency burden and discloses key behavioral traits: admin role requirement, server-side execution, gs.print() return behavior, and the optional Playwright dependency. It does not explicitly mention that scripts may modify data, but the schema already covers the confirm parameter for destructive keywords.

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?

Three sentences, front-loaded with the main purpose, followed by execution details and a dependency note. Every sentence adds value with no filler.

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?

For a script execution tool with 4 parameters and no output schema, the description covers the core purpose, output mechanism, auth prerequisite, and a unique dependency. It could mention potential side effects or error handling, but the schema handles the confirm parameter and the description is otherwise comprehensive.

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 100%, so the baseline is 3. The description adds minimal parameter-specific value beyond the schema—it mentions GlideRecord/GlideSystem and gs.print() but does not elaborate on scope, confirm, or timeout behavior. The schema already documents these parameters sufficiently.

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 the tool executes background scripts on the ServiceNow instance, specifically server-side GlideRecord/GlideSystem JavaScript, returning gs.print() output. This verb+resource combination distinguishes it from sibling tools like sn_query or sn_update, which perform standard operations.

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 provides clear context: it is for executing custom server-side JavaScript, requires admin role, and returns gs.print() output. It does not explicitly name alternatives or when-not-to-use, but the custom-script context implicitly differentiates it from CRUD-focused siblings.

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