ConsignCloud MCP Server

Instructions

Implementation Reference

• src/client.ts:248-250 (handler)

  Core implementation of the create_batch tool: sends POST request to /batches API endpoint with provided data and returns the created Batch object.

  async createBatch(data: Partial<Batch>): Promise<Batch> {
    const response = await this.client.post('/batches', data);
    return response.data;

• src/server.ts:303-313 (registration)

  Registers the 'create_batch' tool in the MCP tools list, including name, description, and input schema definition.

  {
    name: 'create_batch',
    description: 'Create a new batch of items',
    inputSchema: {
      type: 'object',
      properties: {
        description: { type: 'string' },
        account: { type: 'string', description: 'Account ID' },
      },
    },
  },

• src/server.ts:502-503 (handler)

  MCP server-side handler for tool calls: receives arguments, invokes client.createBatch, and formats response as MCP content.

  case 'create_batch':
    return { content: [{ type: 'text', text: JSON.stringify(await client.createBatch(args as any), null, 2) }] };

• src/types.ts:50-58 (schema)

  TypeScript interface defining the Batch object structure, used as return type for createBatch.

  export interface Batch {
    id: string;
    created: string;
    status: 'submitted' | 'draft';
    platform_editing_on: 'portal' | 'consigncloud';
    number: string;
    description: string | null;
    account: string | null;
  }