io.github.ufhouck/chirak-mcp
Model Context Protocol (MCP) Server for Chirak Sales & Inventory Assistant
Installation
Ajoutez ceci à la configuration MCP de votre client (Claude Desktop : claude_desktop_config.json ; Cursor : .cursor/mcp.json ; VS Code et les autres utilisent la même forme « mcpServers »).
chirak-mcpclaude mcp add chirak-mcp -e 'CHIRAK_API_KEY=<your chirak_api_key>' -e 'CHIRAK_API_BASE_URL=<CHIRAK_API_BASE_URL>' -- npx -y chirak-mcp@1.1.2
{
"mcpServers": {
"chirak-mcp": {
"command": "npx",
"args": [
"-y",
"chirak-mcp@1.1.2"
],
"env": {
"CHIRAK_API_KEY": "<your chirak_api_key>",
"CHIRAK_API_BASE_URL": "<CHIRAK_API_BASE_URL>"
}
}
}
}
Variables d'environnement
CHIRAK_API_KEYobligatoire secret Your Chirak API Key starting with chk_live_ (generated from Chirak App -> More -> Integrations & AI)CHIRAK_API_BASE_URLChirak Cloud API Endpoint (optional, defaults to https://chirak.app/api/v1)
Documentation
Tirée du README du projet sur GitHub, actualisée chaque semaine. Les liens ouvrent GitHub.
Sommaire
Chirak MCP Server
A Model Context Protocol (MCP) server that connects AI clients (Claude Desktop, Cursor, Windsurf) to the Chirak Sales, Inventory, and Order Management API.
Overview
The Chirak MCP server enables Large Language Model (LLM) interfaces to perform real-time inventory lookups, record sales transactions, manage product records, and query business analytics via standard Model Context Protocol tooling over STDIO.
Prerequisites
- Node.js 18.0.0 or higher
- A Chirak API key (generated from the Chirak iOS/iPadOS application under Settings > Integrations & AI)
Installation and Configuration
Smithery (Automatic Installation)
To install Chirak for Claude Desktop automatically using Smithery:
npx -y smithery mcp add ufhouck/chirak
Claude Desktop (Manual Configuration)
Add the following configuration to your claude_desktop_config.json:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"chirak": {
"command": "npx",
"args": ["-y", "chirak-mcp"],
"env": {
"CHIRAK_API_KEY": "your_api_key_here"
}
}
}
}
Cursor and Windsurf
Configure the MCP server within your editor's MCP settings:
- Command:
npx - Arguments:
-y chirak-mcp - Environment Variables:
CHIRAK_API_KEY:your_api_key_here
Smithery
To install via Smithery CLI:
npx -y smithery mcp add ufhouck/chirak
Environment Variables
| Variable | Required | Description |
|---|---|---|
CHIRAK_API_KEY | Yes | Authentication key for Chirak Cloud API (chk_live_...). |
CHIRAK_API_BASE_URL | No | Target API endpoint (default: https://chirak.app/api/v1). |
Tools
Inventory and Products
| Tool | Description |
|---|---|
get_products | List and search inventory items with optional filters by category, stock level, or query string. |
add_product | Create a new product entry with SKU, name, prices, barcode, and initial stock. |
update_stock | Adjust inventory counts with specified movement type (inbound, outbound, audit, loss). |
update_product | Modify existing product attributes such as title, price, or category. |
delete_product | Remove an inventory item record. |
Sales and Orders
| Tool | Description |
|---|---|
get_sales | Retrieve recent orders and sales records filtered by date or status. |
record_sale | Create a sales transaction with line items, applied payment methods, and customer association. |
cancel_sale | Void a sales transaction and automatically return items to inventory. |
get_daily_summary | Retrieve daily aggregated metrics including total revenue, profit, transaction count, and top-selling products. |
Customer Management
| Tool | Description |
|---|---|
get_customers | Query customer records, outstanding balances, and purchase summaries. |
add_customer | Create a new customer profile. |
update_customer | Update contact information and customer notes. |
delete_customer | Remove a customer record. |
Documents & Invoices (Billing)
| Tool | Description |
|---|---|
list_documents | Retrieve invoices, receipts, return invoices, and quotes with type/status filters. |
get_document | Fetch full itemized document details, customer details, and tax/VAT calculations. |
create_document | Create and issue formal invoices, sales receipts, or quotes with line items. |
delete_document | Permanently remove an invoice or receipt record. |
export_document_text | Render formatted ASCII thermal receipt / ticket layout suitable for printing or chat display. |
Development
Clone the repository and install dependencies:
git clone https://github.com/ufhouck/chirak-mcp.git
cd chirak-mcp
npm install
npm run build
To run locally using STDIO:
export CHIRAK_API_KEY="your_api_key_here"
node dist/index.js
Security
- All API communications are conducted over TLS (HTTPS).
- API credentials are authenticated server-side using SHA-256 hash matching.
- Requests operate strictly within isolated tenant database partitions.
Privacy Policy
Chirak values developer and user privacy. When interacting with this MCP server:
- All data transmission between AI clients and Chirak Cloud API is encrypted in transit using TLS.
- Store database partitions are strictly multi-tenant isolated by tenant ID.
- API keys are verified server-side using SHA-256 hashes and are never stored in plain text.
- Full Privacy Policy documentation: https://chirak.app/privacy
License
MIT License. See LICENSE for details.
Questions fréquentes
Qu'est-ce que io.github.ufhouck/chirak-mcp ?
Model Context Protocol (MCP) Server for Chirak Sales & Inventory Assistant
Comment installer io.github.ufhouck/chirak-mcp ?
Il s'exécute sur votre machine. Dans Claude Code : claude mcp add chirak-mcp -e 'CHIRAK_API_KEY=<your chirak_api_key>' -e 'CHIRAK_API_BASE_URL=<CHIRAK_API_BASE_URL>' -- npx -y chirak-mcp@1.1.2. Pour les autres clients, collez la configuration JSON de cette page dans leurs réglages MCP.
Faut-il une clé API pour io.github.ufhouck/chirak-mcp ?
Oui. Il attend CHIRAK_API_KEY, à renseigner dans sa configuration.
io.github.ufhouck/chirak-mcp est-il open source ?
Oui. Son code est sur GitHub sous licence MIT.
Qui maintient io.github.ufhouck/chirak-mcp ?
Il est publié par ufhouck. AI.tn le référence sans le maintenir ni le recommander.
Issu du registre MCP officiel. Être listé n'est pas une recommandation : vérifiez le code et les permissions d'un serveur avant de lui donner accès à vos données.