Skip to main content

MCP server for Katana Manufacturing ERP

Project description

Katana MCP Server

Model Context Protocol (MCP) server for Katana Manufacturing ERP.

Features

  • Inventory Management: Check stock levels, find low stock items, search items (products, materials, services)
  • Environment-based Authentication: Secure API key management
  • Built-in Resilience: Automatic retries, rate limiting, and pagination
  • Type Safety: Pydantic models for all requests and responses

Installation

pip install katana-mcp-server

Quick Start

1. Get Your Katana API Key

Obtain your API key from your Katana account settings.

2. Configure Environment

Create a .env file or set environment variable:

export KATANA_API_KEY=your-api-key-here

Or create .env file:

KATANA_API_KEY=your-api-key-here
KATANA_BASE_URL=https://api.katanamrp.com/v1  # Optional, uses default if not set

3. Use with Claude Desktop

Add to your Claude Desktop configuration (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):

{
  "mcpServers": {
    "katana": {
      "command": "uvx",
      "args": ["katana-mcp-server"],
      "env": {
        "KATANA_API_KEY": "your-api-key-here"
      }
    }
  }
}

Restart Claude Desktop, and you'll see Katana inventory tools available!

4. Run Standalone (Optional)

For testing or development:

export KATANA_API_KEY=your-api-key
katana-mcp-server

Available Tools

check_inventory

Check stock levels for a specific product SKU.

Parameters:

  • sku (string, required): Product SKU to check

Example Request:

{
  "sku": "WIDGET-001"
}

Example Response:

{
  "sku": "WIDGET-001",
  "product_name": "Premium Widget",
  "available_stock": 150,
  "in_production": 50,
  "committed": 75
}

Use Cases:

  • "What's the current stock level for SKU WIDGET-001?"
  • "Check inventory for my best-selling product"
  • "How much stock do we have available for order fulfillment?"

list_low_stock_items

Find products below a specified stock threshold.

Parameters:

  • threshold (integer, optional, default: 10): Stock level threshold
  • limit (integer, optional, default: 50): Maximum items to return

Example Request:

{
  "threshold": 5,
  "limit": 20
}

Example Response:

{
  "items": [
    {
      "sku": "PART-123",
      "product_name": "Component A",
      "current_stock": 3,
      "threshold": 5
    },
    {
      "sku": "PART-456",
      "product_name": "Component B",
      "current_stock": 2,
      "threshold": 5
    }
  ],
  "total_count": 15
}

Use Cases:

  • "Show me products with less than 10 units in stock"
  • "What items need reordering?"
  • "Find critical low stock items (below 5 units)"

search_items

Search for items (products, materials, services) by name or SKU.

Parameters:

  • query (string, required): Search term (matches name or SKU)
  • limit (integer, optional, default: 20): Maximum results to return

Example Request:

{
  "query": "widget",
  "limit": 10
}

Example Response:

{
  "items": [
    {
      "id": 12345,
      "sku": "WIDGET-001",
      "name": "Premium Widget",
      "is_sellable": true,
      "stock_level": null
    },
    {
      "id": 12346,
      "sku": "WIDGET-002",
      "name": "Economy Widget",
      "is_sellable": true,
      "stock_level": null
    }
  ],
  "total_count": 2
}

Note: stock_level is always null for search results in the current implementation.

Use Cases:

  • "Find all products containing 'widget'"
  • "Search for SKU PART-123"
  • "What items do we have for order creation?"
  • "Show me all sellable products vs internal materials"

Configuration

Environment Variables

  • KATANA_API_KEY (required): Your Katana API key
  • KATANA_BASE_URL (optional): API base URL (default: https://api.katanamrp.com/v1)
  • KATANA_MCP_LOG_LEVEL (optional): Log level - DEBUG, INFO, WARNING, ERROR (default: INFO)
  • KATANA_MCP_LOG_FORMAT (optional): Log format - json, text (default: json)

Logging Configuration

The server uses structured logging with configurable output format and verbosity:

Development (verbose text logs):

export KATANA_MCP_LOG_LEVEL=DEBUG
export KATANA_MCP_LOG_FORMAT=text
katana-mcp-server

Production (structured JSON logs):

export KATANA_MCP_LOG_LEVEL=INFO
export KATANA_MCP_LOG_FORMAT=json
katana-mcp-server

See docs/LOGGING.md for complete logging documentation.

Advanced Configuration

The server uses the katana-openapi-client library with:

  • Automatic retries on rate limits (429) and server errors (5xx)
  • Exponential backoff with jitter
  • Transparent pagination for large result sets
  • 30-second default timeout

Troubleshooting

"KATANA_API_KEY environment variable is required"

Cause: API key not set in environment.

Solution: Set the environment variable or add to .env file:

export KATANA_API_KEY=your-api-key-here

"Authentication error: 401 Unauthorized"

Cause: Invalid or expired API key.

Solution: Verify your API key in Katana account settings and update the environment variable.

Tools not showing up in Claude Desktop

Cause: Configuration error or server not starting.

Solutions:

  1. Check Claude Desktop logs: ~/Library/Logs/Claude/mcp*.log
  2. Verify configuration file syntax (valid JSON)
  3. Test server standalone: katana-mcp-server (should start without errors)
  4. Restart Claude Desktop after configuration changes

Rate limiting (429 errors)

Cause: Too many requests to Katana API.

Solution: The server automatically retries with exponential backoff. If you see persistent rate limiting, reduce request frequency.

Development

Prerequisites

  • uv package manager - Install uv
  • Python 3.12+ (for hot-reload mode)

Development Mode with Hot Reload ⚡

For rapid iteration during development, use hot-reload mode to see changes instantly without rebuilding or restarting:

# 1. Install dependencies
cd katana_mcp_server
uv sync

# 2. Install mcp-hmr (requires Python 3.12+)
uv pip install mcp-hmr

# 3. Run with hot reload
uv run mcp-hmr src/katana_mcp/server.py:mcp

Benefits:

  • Edit code → Save → Changes apply instantly
  • No rebuild, no reinstall, no restart needed
  • Keep your Claude Desktop conversation context
  • Iteration time: ~5 seconds instead of 5-10 minutes

Claude Desktop Configuration for Development:

{
  "mcpServers": {
    "katana-erp-dev": {
      "comment": "Use full path to uv - find with: which uv",
      "command": "/Users/YOUR_USERNAME/.local/bin/uv",
      "args": ["run", "mcp-hmr", "src/katana_mcp/server.py:mcp"],
      "cwd": "/absolute/path/to/katana-openapi-client/katana_mcp_server",
      "env": {
        "KATANA_API_KEY": "your-api-key-here"
      }
    }
  }
}

Important:

  • Replace YOUR_USERNAME with your actual username
  • Run which uv to find the correct uv path (usually ~/.local/bin/uv)
  • Replace /absolute/path/to/ with your repository path
  • Hot reload requires Python >=3.12. For Python 3.11 users, use the production install method.

See DEVELOPMENT.md for the complete development guide.

Install from Source

git clone https://github.com/dougborg/katana-openapi-client.git
cd katana-openapi-client/katana_mcp_server
uv sync

Run Tests

# Unit tests only (no API key needed)
uv run pytest tests/ -m "not integration"

# All tests (requires KATANA_API_KEY)
export KATANA_API_KEY=your-key
uv run pytest tests/

Build and Install Locally

# Build the package
uv build

# Install with pipx
pipx install --force dist/katana_mcp_server-*.whl

Version

Current version: 0.1.0a1 (alpha release)

This is an alpha release with 3 inventory management tools. Future releases will add:

  • Sales order management
  • Purchase order management
  • Manufacturing order management
  • Custom resources and prompts

Links

License

MIT License - see LICENSE file for details

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

katana_mcp_server-0.21.0.tar.gz (114.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

katana_mcp_server-0.21.0-py3-none-any.whl (55.2 kB view details)

Uploaded Python 3

File details

Details for the file katana_mcp_server-0.21.0.tar.gz.

File metadata

  • Download URL: katana_mcp_server-0.21.0.tar.gz
  • Upload date:
  • Size: 114.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for katana_mcp_server-0.21.0.tar.gz
Algorithm Hash digest
SHA256 71d2426895758a20f915c370532d757e82db7342b58352bbd994d48a36f43524
MD5 5707ae27e8433204fc09e96e5dfe4859
BLAKE2b-256 471cb69c2513af0d5d90fcb7f7e2473a2599129d0b15f91d354745acf1d12557

See more details on using hashes here.

Provenance

The following attestation bundles were made for katana_mcp_server-0.21.0.tar.gz:

Publisher: release.yml on dougborg/katana-openapi-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file katana_mcp_server-0.21.0-py3-none-any.whl.

File metadata

File hashes

Hashes for katana_mcp_server-0.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1baa8b5d859f98a965b48a9087a44457accc3c434d9f48d140e5923ad560711
MD5 0702a6a5091496344a97c4d28b398e65
BLAKE2b-256 8b5781c96313f0145cc9c30bc3dccb1ecbb088905a60724d887a20cb28d8dd45

See more details on using hashes here.

Provenance

The following attestation bundles were made for katana_mcp_server-0.21.0-py3-none-any.whl:

Publisher: release.yml on dougborg/katana-openapi-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page