Retrieve details of a specific import list by its ID to view its configuration and status.
Read ImportList.
GET /api/v3/importlist/{id}
Args: id: Path parameter.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the agent knows it's a safe read. The description adds no additional behavioral context (e.g., error handling, response format). It doesn't contradict annotations, but also doesn't add value beyond them.
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 extremely brief, with a single line and a code snippet. It's concise but not well-structured; it lacks any contextual sentences. While it's short, it's under-specified rather than efficient.
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 and annotations, the description is still incomplete. It doesn't explain the semantics of the ImportList resource, nor does it provide any usage context. With many sibling get_*_by_id tools, the agent may not know which one to pick. The minimal description is insufficient for a tool with zero schema coverage.
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 description only repeats the schema's 'id: Path parameter' without explaining what the ID represents or any format expectations. Since schema coverage is 0%, the description should compensate, but it doesn't. The parameter's meaning is left entirely to inference.
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 states 'Read ImportList' clearly, indicating a read operation on a specific resource. The name itself suggests fetching by ID, and it's distinct from list_importlist and create/update/delete tools. However, it doesn't elaborate on what an ImportList is, so it's not fully self-contained.
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?
No guidance on when to use this tool versus alternatives like list_importlist or other get_*_by_id tools. It doesn't mention prerequisites or when to choose this over listing. Lacks explicit when/when-not guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.