ConsignCloud

You run the ConsignCloud MCP Server to enable AI assistants to manage inventory, sales, accounts, and more in your consignment or retail workflow. It provides both a local, stdio-based setup for plug-and-play usage and an HTTP/SSE server for testing and MCP tooling integrations, so you can choose the development or production path that fits your environment.

How to use

Connect an MCP client (such as Claude Desktop or MCP Inspector) to the server using either the STDIO mode or the HTTP/SSE mode. In STDIO mode, the server runs as a local process and exposes the MCP endpoints through standard input/output. In HTTP/SSE mode, the server starts an HTTP server with a Server-Sent Events feed to listen for requests from MCP clients.

How to install

# Prerequisites
- Install Node.js (includes npm) on your system

# Step 1: Get the server code
git clone <repository-url>
cd mcp-consigncloud

# Step 2: Install dependencies
npm install

# Step 3: Create and configure environment
cp .env.example .env

# Step 4: Configure API access in the environment file
CONSIGNCLOUD_API_KEY=your_api_key_here
CONSIGNCLOUD_API_BASE_URL=https://api.consigncloud.com/api/v1

You can also open and edit the file to add any other values your setup requires. The server supports two modes for operation: STDIO for local clients and HTTP/SSE for testing and MCP tooling.

To start in STDIO mode (for Claude Desktop and similar clients): use the development or production commands below.

To start in HTTP/SSE mode (for testing with MCP Inspector): use the HTTP server commands below.

Additional setup and running details

Claude Desktop integration example shows how you can configure a local STDIO server by pointing to the built JavaScript entry, for example with a path to dist/index.js and the node runtime. You can also enable environment variables directly in the configuration to supply your API key.

Here are the concrete commands you’ll use for runtime modes.

Notes on runtime modes and commands

STDIO mode (local, Claude Desktop and MCP clients): you typically run the server with a command such as node dist/index.js or the project’s provided development script. Use the full path to the built entry as shown in the configuration examples.

HTTP/SSE mode (testing and MCP Inspector): you run an HTTP server that exposes the MCP endpoints over HTTP.

Connecting with Claude Desktop or MCP tools

Configure Claude Desktop with a local STDIO server by providing the command and the path to the entry point, and optionally include CONSIGNCLOUD_API_KEY in the environment. You can also connect with MCP Inspector using the http://localhost:3000 base URL when running in HTTP/SSE mode.

Troubleshooting and tips

If you encounter authentication or connection issues, verify your API key in the environment file and ensure the ConsignCloud API app is enabled in your account. For HTTP/SSE startup problems, confirm the environment file exists and contains valid values and that the server can reach the ConsignCloud API host.

Dev vs production start flows

Development: use the project’s dev command for the mode you are using. Production: build the project and then start the server in the chosen mode. The HTTP server supports overriding environment values with CLI flags for quick testing.

Available tools

list_items

List inventory items with filters such as price, category, account, status, and location.

get_item

Retrieve detailed information for a specific inventory item.

create_item

Create a new inventory item with the required fields.

update_item

Update properties of an existing inventory item.

delete_item

Soft delete an inventory item.

get_item_stats

Get aggregated statistics for the inventory.

list_sales

List sales with filters like date, customer, location, and status.

get_sale

Get details for a specific sale.

void_sale

Void a sale.

get_sales_trends

Retrieve sales analytics and trends.

list_accounts

List vendor or consignor accounts.

get_account

Get details for a specific account.

create_account

Create a new vendor/consignor account.

update_account

Update an existing account.

get_account_stats

Get statistics for an account.

list_categories

List item categories.

create_category

Create a new item category.

list_locations

List store locations.

list_batches

List item batches.

create_batch

Create a new item batch.

update_batch_status

Change the status of a batch.

search_suggest

Search across entities for suggestions.