Katana MCP Server Documentation

This directory contains all documentation specific to the katana-mcp-server package.

Documentation Index

Getting Started

• Development Guide - Setup and development workflow
• Deployment Guide - Production deployment strategies
• Docker Guide - Container deployment
• Logging - Structured logging configuration

Architecture & Design

• Architecture Design - Comprehensive MCP architecture and patterns
• ADRs - Architecture Decision Records

Subsystem Guides

Topical references that go deeper than the architecture overview. Open the relevant README when working in that subsystem.

• Prefab UI - Card builders, DataTable mustache binding, register_preview_tool + meta=UI_META contract, browser-render harness pitfalls.
• Typed Cache - SQLite-backed cache, FTS5 search, archive / deleted soft-state, Cached<Name> sibling tables, sync postprocessing.

Cookbook

Task-oriented recipes covering specific behaviors of the MCP server. Reach for these when you're debugging a "why doesn't this work?" or extending a subsystem.

• Catalog Search - How search_items / search_customers work end-to-end: tokenizer, FTS5 sidecar, SQLite triggers, variant denormalization, soft-state filtering.

Quick Links

• Main Repository README - Project overview
• Contributing Guide - How to contribute
• PyPI Package - Published package

Related Packages

This monorepo also contains:

• katana-openapi-client - Python client for Katana Manufacturing API