create_record

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

Adds context beyond annotations: requires write permission, dry_run preview. No contradiction with annotations (readOnlyHint=false, etc.). Does not describe return format, but annotations already indicate mutability.

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?

Two sentences, front-loaded with purpose and prerequisite, no fluff. Every sentence earns its place.

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?

Missing return value description (e.g., sys_id of created record). Dry_run behavior partially addressed. With no output schema, description should clarify return but falls short.

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%, baseline 3. Description adds scope to table parameter ('any ServiceNow table') and dry_run behavior. Fields parameter not enriched beyond schema, but overall adds value.

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?

Clearly states verb ('Create'), resource ('new record in any ServiceNow table'), and prerequisite (WRITE_ENABLED=true). Distinguishes from siblings (e.g., specific create_incident) by being general-purpose.

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?

Provides prerequisite (WRITE_ENABLED=true) and a use case (dry_run preview). Does not explicitly contrast with specific create tools but implicitly guides toward general table creation.

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