Skip to main content
Glama

getDuplicateCollectionTaskStatus

Read-onlyIdempotent

Check the progress or completion status of a collection duplication task by providing its task ID.

Instructions

Gets the status of a collection duplication task.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
taskIdYesThe task's unique ID.

Implementation Reference

  • The handler function for getDuplicateCollectionTaskStatus. It calls GET /collection-duplicate-tasks/{taskId} to check the status of a collection duplication task.
    export async function handler(
      args: z.infer<typeof parameters>,
      extra: { client: PostmanAPIClient; headers?: IsomorphicHeaders; serverContext?: ServerContext }
    ): Promise<CallToolResult> {
      try {
        const endpoint = `/collection-duplicate-tasks/${args.taskId}`;
        const query = new URLSearchParams();
        const url = query.toString() ? `${endpoint}?${query.toString()}` : endpoint;
        const options: any = {
          headers: extra.headers,
        };
        const result = await extra.client.get(url, options);
        return {
          content: [
            {
              type: 'text',
              text: `${typeof result === 'string' ? result : JSON.stringify(result, null, 2)}`,
            },
          ],
        };
      } catch (e: unknown) {
        if (e instanceof McpError) {
          throw e;
        }
        throw asMcpError(e);
      }
    }
  • Input schema: requires a taskId string parameter.
    export const parameters = z.object({ taskId: z.string().describe("The task's unique ID.") });
  • Tool registration metadata: method name, description, schema, and annotations (read-only, idempotent).
    export const method = 'getDuplicateCollectionTaskStatus';
    export const description = 'Gets the status of a collection duplication task.';
    export const parameters = z.object({ taskId: z.string().describe("The task's unique ID.") });
    export const annotations = {
      title: 'Gets the status of a collection duplication task.',
      readOnlyHint: true,
      destructiveHint: false,
      idempotentHint: true,
    };
  • Listed in the 'full' enabled resources array, registering it as an available tool.
    // Duplicate Collection
    'duplicateCollection',
    'getDuplicateCollectionTaskStatus',
    'deleteApiCollectionComment',
    'deleteSpecFile',
    'getEnabledTools',
    'searchPostmanElements',
  • Listed in the 'minimal' enabled resources array, registering it as an available tool in minimal mode.
      'duplicateCollection',
      'getDuplicateCollectionTaskStatus',
      'runCollection',
      'getEnabledTools',
      'updateCollectionRequest',
    ] as const;
Behavior2/5

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

Annotations already provide readOnlyHint, destructiveHint, and idempotentHint. The description adds no further behavioral context (e.g., behavior on invalid taskId, possible status values). It merely repeats the title.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, front-loaded with the core action. No extraneous words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite simple structure and good annotations, the description omits return value details (e.g., status fields, error handling) that would help an agent use the result. Output schema is absent, so description should compensate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% for the single parameter 'taskId', so the baseline is 3. The tool description adds no extra meaning beyond the schema's 'The task's unique ID.'

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Gets the status of a collection duplication task' uses a specific verb ('Gets') and resource ('status of a collection duplication task'), clearly distinguishing it from sibling tools like 'duplicateCollection' (which initiates duplication) and other get tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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, such as after calling 'duplicateCollection' or for polling status. The description lacks explicit context about temporal or conditional use.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/postmanlabs/postman-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server