Orderful MCP Server

An MCP (Model Context Protocol) server that provides access to the Orderful EDI API, enabling Claude to interact with your EDI transactions, trading partners, and document workflows.

Features

This MCP server exposes the following Orderful API capabilities:

$3

- get-organization - Get your Orderful organization details

$3

- list-transactions - List EDI transactions with filtering (type, status, date range)
- get-transaction - Get details of a specific transaction
- get-transaction-message - Get the raw EDI message content
- create-transaction - Create a new EDI transaction

$3

- get-polling-bucket - Retrieve transactions from a polling bucket for processing

$3

- get-delivery - Get delivery details
- approve-delivery - Approve a transaction delivery
- fail-delivery - Mark a delivery as failed

$3

- list-relationships - List all trading partner relationships

$3

- create-acknowledgment - Create an acknowledgment (997/999) for a transaction
- get-acknowledgment - Get acknowledgment details

$3

- get-attachment - Get attachment metadata

$3

- convert-data - Convert between X12, EDIFACT, and JSON formats

$3

- generate-label - Generate shipping labels from transaction data

Installation

1. Clone or copy this directory
2. Install dependencies:
``bash
cd orderful-mcp-server
npm install
`

3. Build the TypeScript:
`bash
npm run build
`

Configuration

Set your Orderful API key as an environment variable:

`bash
export ORDERFUL_API_KEY="your-api-key-here"
`

Usage with Claude Desktop

Add the following to your Claude Desktop configuration file:

$3


Edit ~/Library/Application Support/Claude/claude_desktop_config.json:

`json
{
"mcpServers": {
"orderful": {
"command": "node",
"args": ["/Users/jamesmartin/Documents/orderful-mcp-server/dist/index.js"],
"env": {
"ORDERFUL_API_KEY": "[YOUR API KEY HERE]"
}
}
}
}
`

$3


Edit %APPDATA%\Claude\claude_desktop_config.json:

`json
{
"mcpServers": {
"orderful": {
"command": "node",
"args": ["C:\\path\\to\\orderful-mcp-server\\dist\\index.js"],
"env": {
"ORDERFUL_API_KEY": "your-api-key-here"
}
}
}
}
`

Development

Run in development mode with hot reloading:
`bash
npm run dev
`

Available Transaction Types

Common EDI transaction types supported by Orderful:
- 850_PURCHASE_ORDER - Purchase Order
- 855_PURCHASE_ORDER_ACKNOWLEDGMENT - PO Acknowledgment
- 856_SHIP_NOTICE - Advance Ship Notice (ASN)
- 810_INVOICE - Invoice
- 860_PURCHASE_ORDER_CHANGE_REQUEST - PO Change Request
- 945_WAREHOUSE_SHIPPING_ADVICE - Warehouse Shipping Advice
- 944_WAREHOUSE_STOCK_TRANSFER - Warehouse Stock Transfer
- 997_FUNCTIONAL_ACKNOWLEDGMENT - Functional Acknowledgment

Status Values

$3


- PROCESSING - Transaction is being validated
- VALID - Transaction passed validation
- INVALID - Transaction failed validation

$3

- PENDING - Delivery not yet attempted
- SENT - Delivery in progress
- DELIVERED - Successfully delivered
- FAILED - Delivery failed

$3

- PENDING - Awaiting acknowledgment
- ACCEPTED - Transaction accepted
- REJECTED - Transaction rejected

Example Usage in Claude

Once configured, you can ask Claude things like:

- "Show me the recent purchase orders from Walmart"
- "Get the details of transaction 12345"
- "List all transactions that failed delivery in the last week"
- "What trading partners do we have configured?"
- "Check our polling bucket for new inbound transactions"
- "Approve delivery for transaction 67890"

API Documentation

For more details on the Orderful API, visit: https://docs.orderful.com/reference/overview

Troubleshooting

1. API Key Issues: Ensure your ORDERFUL_API_KEY environment variable is set correctly
2. Connection Errors: Verify your network can reach api.orderful.com`
3. Permission Errors: Ensure your API key has the necessary permissions for the operations you're trying to perform

License

MIT