Import Records from XML

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

With no annotations, the description carries the full burden. It states the operation is mutative (creates/updates) and advises caution, but lacks details on error handling, permissions required, idempotency, or what happens if the XML is malformed. It adds some value beyond a simple label but remains incomplete.

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 at two sentences plus a bold warning. It front-loads the core purpose and uses structure effectively with an important note. Every sentence serves a clear purpose without redundancy.

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 mutative tool with no output schema, the description covers purpose, input format, mutative behavior, and use cases. It lacks details on what the operation returns (e.g., success message, record count) and error conditions, but is fairly complete given the parameter descriptions already handle details.

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?

The input schema has 100% coverage with parameter descriptions, so the schema already explains the parameters well. The description adds only the processor detail (sys_upload.do) and doesn't further clarify parameter meaning beyond what's in the 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 it imports XML records into a ServiceNow instance, specifies the format (ServiceNow unload XML), and gives concrete use cases like restoring configurations and migrating records. It distinguishes itself from sibling tools like batch_create_records by focusing on XML format and the sys_upload.do processor.

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 specific use cases ('restoring configurations, migrating records between instances, or applying exported record definitions') and warns about the mutative nature and need to verify content. However, it does not explicitly contrast with alternatives like batch_create_records or export_record_xml, nor does it state when not to use this tool.

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