Preview an uploaded import job to review detected columns, sample data, and column mapping suggestions before executing.
Get a preview of an uploaded import job including detected columns, sample data, and column mapping suggestions. Use after uploading a file to review before executing.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Import job ID | |
| companyId | No | Company UUID override (uses active company if not set) |
Changes observed during successful MCP inspections.
v1.0.17Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds value the annotations cannot: what the response actually contains (detected columns, sample data, mapping suggestions), which matters because there is no output schema. It does not mention whether the preview expires or how long an import job stays previewable.
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, zero waste. The capability statement is front-loaded and the usage note follows it; nothing repeats the schema or the annotations.
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 read-only, two-parameter tool with no output schema, the description covers what it returns and where it fits in the import sequence. The only gaps are relatively fine operational details: preview lifetime and whether the mapping suggestions are applied via a separate tool.
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% and both parameters carry their own descriptions, so the baseline is 3. The description implies the id comes from a prior upload ('after uploading a file'), which hints at the parameter's provenance, but adds no format, scoping, or companyId guidance beyond 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?
Specific verb ('Get a preview') plus a specific resource ('an uploaded import job') and an explicit enumeration of what the preview contains (detected columns, sample data, mapping suggestions). This separates it cleanly from import_upload, import_mapping, import_execute, and import_get without opening any schema.
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 sentence 'Use after uploading a file to review before executing' gives an explicit position in the workflow and implies the alternatives (upload first, execute later). It stops short of naming the sibling tools or stating exclusions, so it is clear context rather than a full when/when-not rule.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.