Kash Business management

Assistente de gestão Kash.click. Conecte seu assistente ao seu negócio: histórico completo de vendas, clientes, pagamentos, informações fiscais, funcionários e pontos de venda.

GitHub

Documentação

🧾 Kash MCP Server

Kash MCP Server é o servidor oficial do Model Context Protocol (MCP) para Kash — uma plataforma gratuita de PDV, faturamento, CRM e loja virtual baseada em nuvem, confiável por milhares de comerciantes desde 2011.

Conecte sua conta Kash ao Claude, ChatGPT, n8n ou a qualquer IA compatível com MCP — e gerencie todo o seu negócio por meio de conversa natural.

🟢 Servidor hospedado: https://mcp.kash.click
📖 Documentação completa: kash.click/cash-register-software

✨ O que você pode fazer

Apenas converse. Sem menus, sem cliques.

"Record a sale of 2 coffees and 1 croissant at table 84"
"Show me this week's revenue report"
"Add a new item called Summer Tart at €4.50 in the Pastries department"
"Who are my best customers this month?"
"Create a Kash account for my restaurant"
"Record the card payment for order #1042"
"Add a Large size option to the Size variation"

🚀 Recursos

🔐 Conta e Autenticação — sem configuração necessária

Crie uma nova conta Kash diretamente da conversa
Liste contas vinculadas a um e-mail para verificar se já existe uma
Login via OTP — uma senha de uso único é enviada para o seu e-mail, sem necessidade de senha
Faça logout para limpar a sessão a qualquer momento

🧾 Vendas e Pedidos

Registre vendas com itens do catálogo, linhas de departamento ou linhas livres
Edite pedidos — adicione itens, atribua um cliente, registre pagamentos, valide como fatura
Liste pedidos por intervalo de datas, validados ou não validados, filtrados por método de entrega
Obtenha detalhes do pedido — detalhamento completo de itens, cliente, pagamentos e totais

📊 Relatórios

Relatório de vendas — resumo em HTML para qualquer período: um dia específico, mês ou ano inteiro (padrão: ontem)

📦 Gerenciamento de Catálogo

Itens (PLU): adicionar, editar, excluir — com preço, departamento, IVA, código de barras, estoque, variações...
Departamentos: adicionar, editar, excluir — com IVA, preço, grupo, variações...
Grupos de departamentos: adicionar, editar, excluir — para organizar seu catálogo
Taxas de IVA: adicionar, editar, excluir
Variações: adicionar, editar, excluir (ex.: "Tamanho", "Cor")
Opções de variação: adicionar, editar, excluir (ex.: "S", "M", "L" para "Tamanho") com delta de preço opcional

👥 Gerenciamento de Clientes (CRM)

Adicione, edite, exclua clientes com informações completas de contato, detalhes da empresa, número de IVA, código de barras, dados de fidelidade, notas privadas, status de lista negra...

📋 Dados e Listas

Recupere qualquer dado de referência da sua loja:

Ferramenta	Dados
`data.list.products`	Itens / artigos
`data.list.departments`	Departamentos / categorias
`data_list_department_groups`	Grupos de departamentos
`data_list_vats`	Taxas de IVA
`data_list_clients`	Clientes
`data_list_variations`	Tipos de variação
`data_list_payments`	Métodos de pagamento
`data_list_cashboxes`	Caixas registradoras
`data_list_delivery_men`	Métodos de entrega
`data_list_delivery_zones`	Zonas de entrega
`data_list_relay_points`	Pontos de retransmissão / retirada
`data_list_discounts`	Descontos e suplementos
`data.list.users`	Equipe / usuários
`data_list_tables`	Mesas (modo restaurante)
`data.list.orders`	Pedidos por intervalo de datas

🛠 Ferramentas Disponíveis (46)

Categoria	Ferramentas
Conta	`account.list`, `account.create`
Autenticação	`auth.request.otp`, `auth.login.with_otp`, `auth.logout`
Vendas	`order.create`, `order.edit`, `order.detail`, `data.list.orders`, `data.list.pending_orders`
Relatórios	`report.get`
Itens	`plu_add`, `plu_edit`, `plu_delete`, `data.list.products`
Departamentos	`dept_add`, `dept_edit`, `dept_delete`, `data.list.departments`
Grupos de dept.	`dept_group_add`, `dept_group_edit`, `dept_group_delete`, `data_list_department_groups`
IVA	`vat_add`, `vat_edit`, `vat_delete`, `data_list_vats`
Variações	`variation_add`, `variation_edit`, `variation_delete`, `data_list_variations`
Opções de variação	`variation_choice_add`, `variation_choice_edit`, `variation_choice_delete`
Clientes	`client_add`, `client_edit`, `client_delete`, `data_list_clients`
Dados	`data_list_payments`, `data_list_cashboxes`, `data_list_delivery_men`, `data_list_delivery_zones`, `data_list_relay_points`, `data_list_discounts`, `data.list.users`, `data_list_tables`
Utilitário	`ping`

⚙️ Pré-requisitos

Você precisa de uma conta Kash / free-cash-register.net.

Não tem uma? Você pode criá-la diretamente da conversa usando account.create, ou registrar-se em kash.click/free-pos-software.

Já tem uma? Recupere seu APIKEY e SHOPID no software em Configuração → Webservices ou conecte-se usando oAuth.

🔌 Opção 1 — Servidor hospedado (recomendado)

A maneira mais fácil: conecte-se diretamente ao servidor MCP hospedado em https://mcp.kash.click/mcp.

Nenhuma instalação necessária. A autenticação é feita via OAuth 2.0 com PKCE.

Claude.ai

Em Configurações → Integrações, adicione um novo conector:

Campo	Valor
Nome	`Kash`
URL do servidor MCP	`https://mcp.kash.click/mcp`
Autenticação	`OAuth`

ChatGPT

Em Configurações → Conectores → Criar Conector:

Campo	Valor
Nome	`Kash POS`
URL do servidor MCP	`https://mcp.kash.click/mcp`
Autenticação	`OAuth`

Smithery

Disponível em smithery.ai — procure por Kash.

💻 Opção 2 — Auto-hospedado (STDIO)

Execute o servidor localmente para Claude Desktop ou qualquer cliente MCP baseado em STDIO.

Início rápido via npx

npx caisse-enregistreuse-mcp-server --shopid=YOUR_SHOPID --apikey=YOUR_APIKEY

Configuração do Claude Desktop

Edite claude_desktop_config.json:

Windows: %APPDATA%\Claude\claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "kash": {
      "command": "npx",
      "args": [
        "caisse-enregistreuse-mcp-server",
        "--shopid=YOUR_SHOPID",
        "--apikey=YOUR_APIKEY"
      ]
    }
  }
}

Ou usando variáveis de ambiente:

{
  "mcpServers": {
    "kash": {
      "command": "node",
      "args": ["PATH_TO_BUILD/build/stdio.js"],
      "cwd": "PATH_TO_BUILD",
      "env": {
        "SHOPID": "YOUR_SHOPID",
        "APIKEY": "YOUR_APIKEY"
      }
    }
  }
}

Instalar a partir do código-fonte

# 1) Clone
git clone https://github.com/paracetamol951/caisse-enregistreuse-mcp-server.git
cd caisse-enregistreuse-mcp-server

# 2) Install dependencies
npm install

# 3) Create .env
echo "SHOPID=YOUR_SHOPID" > .env
echo "APIKEY=YOUR_APIKEY" >> .env

# 4) Build
npm run build

# 5) Run
node build/stdio.js

Docker (modo HTTP)

O modo HTTP requer Redis. Use Docker Compose:

docker compose up

Ou execute manualmente:

docker run -d -p 6379:6379 redis
npm run dev

🔐 Fluxo de autenticação

Servidor hospedado (OAuth)

A autenticação é tratada automaticamente pelo fluxo OAuth 2.0 + PKCE quando você se conecta por meio do Claude.ai, ChatGPT ou Smithery.

Autenticação na conversa (OTP)

Você também pode autenticar diretamente na conversa — sem necessidade de senha:

1. auth.request.otp(email)         → OTP sent to your inbox
2. auth.login.with_otp(email, otp) → session initialized ✓
3. auth.logout()                   → clear session when done

Se você ainda não tem uma conta:

1. account.list(email)             → check existing accounts
2. account.create(email, title)    → create + session auto-initialized ✓

STDIO / auto-hospedado

Passe as credenciais via argumentos de CLI ou variáveis de ambiente — SHOPID e APIKEY.

📡 Endpoints da API

Endpoint	Descrição
`POST https://mcp.kash.click/mcp`	Endpoint JSON-RPC do MCP
`GET https://mcp.kash.click/health`	Verificação de saúde → `{ "status": "ok" }`
`GET https://mcp.kash.click/.well-known/mcp/manifest.json`	Manifesto do MCP (lista de ferramentas)
`GET https://mcp.kash.click/.well-known/openid-configuration`	Descoberta OAuth

🌍 Internacionalização

Os títulos e descrições das ferramentas estão disponíveis em inglês e francês, resolvidos automaticamente a partir do cabeçalho Accept-Language ou da variável de ambiente MCP_LANG.

Arquivos de localidade: locales/en/common.json, locales/fr/common.json

Credenciais de demonstração

Se quiser experimentar a ferramenta sem criar uma conta, você pode usar as seguintes credenciais

💻 Clientes compatíveis

Cliente	Modo
Claude.ai	HTTP / OAuth
Claude Desktop	STDIO
ChatGPT	HTTP / OAuth
n8n	HTTP
Flowise / LangChain	HTTP
Smithery	HTTP / OAuth
Qualquer cliente MCP	STDIO ou HTTP

🏪 Tipos de negócio suportados

Ao criar uma conta com account.create, use configType para pré-carregar um conjunto de dados adaptado ao seu negócio:

Bar · Bakery · Restaurant · Fast-food · Cafe · Coffee-shop · Pizzeria · Brewery · Food-truck · Snack · Florist · Retail · Pharmacy · Supermarket · Clothing-store · Ecommerce · Services · Beauty-institute · Coiffeur · Market · Library · Camping · e mais...

🔗 Links

🌐 Site: kash.click
📖 Documentação: kash.click/cash-register-software
🔧 Referência da API: kash.click/cash-register-software/mcp
🆓 Registre-se gratuitamente: kash.click/free-pos-software