关于 chirak-mcp
chirak-mcp 将 AI 客户端连接到 Chirak 的销售、库存和订单管理 API。其工具涵盖商品与库存记录、交易、客户、单据及业务汇总。
主要功能
- 01搜索和管理商品记录
- 02调整库存并记录销售
- 03查询销售记录和每日指标
- 04管理客户记录
- 05创建和查询发票及报价单
- 06导出格式化收据文本
适用场景
- 01查看商品可用情况和库存
- 02记录或取消销售
- 03查看每日收入和热销商品
- 04创建发票或销售报价单
MCP 相关
它通过 STDIO 向 MCP 客户端提供 Chirak API 操作,包括库存、销售、客户和单据管理工具。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
mcp.json · 通用配置
启动命令
npx -y chirak-mcp需要配置的环境变量
CHIRAK_API_KEY密钥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)本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。
工具
15收录的工具列表 · 更新于 3 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| topic | string | 否 | 可选的特定主题:'products'、'sales'、'customers'、'reports' 或 'general'。 |
详细介绍
Chirak MCP 服务
一个模型上下文协议(MCP)服务,可将 AI 客户端(Claude Desktop、Cursor、Windsurf)连接到 Chirak 销售、库存和订单管理 API。
概述
Chirak MCP 服务支持大语言模型(LLM)界面通过标准模型上下文协议工具,经由 STDIO 实时查询库存、记录销售交易、管理产品记录并查询业务分析数据。
前提条件
- Node.js 18.0.0 或更高版本
- Chirak API 密钥(在 Chirak iOS/iPadOS 应用的 Settings > Integrations & AI 中生成)
安装和配置
Smithery(自动安装)
使用 Smithery 自动为 Claude Desktop 安装 Chirak:
npx -y smithery mcp add ufhouck/chirak
Claude Desktop(手动配置)
将以下配置添加到 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 和 Windsurf
在编辑器的 MCP 设置中配置 MCP 服务:
- 命令:
npx - 参数:
-y chirak-mcp - 环境变量:
CHIRAK_API_KEY:your_api_key_here
Smithery
通过 Smithery CLI 安装:
npx -y smithery mcp add ufhouck/chirak
环境变量
| 变量 | 必需 | 描述 |
|---|---|---|
CHIRAK_API_KEY | 是 | Chirak Cloud API 的身份验证密钥(chk_live_...)。 |
CHIRAK_API_BASE_URL | 否 | 目标 API 端点(默认值:https://chirak.app/api/v1)。 |
工具
库存和产品
| 工具 | 描述 |
|---|---|
get_products | 列出并搜索库存商品,可按类别、库存水平或查询字符串进行筛选。 |
add_product | 创建新的产品条目,包含 SKU、名称、价格、条形码和初始库存。 |
update_stock | 按指定的变动类型(入库、出库、盘点、损耗)调整库存数量。 |
update_product | 修改现有产品属性,例如标题、价格或类别。 |
delete_product | 删除库存商品记录。 |
销售和订单
| 工具 | 描述 |
|---|---|
get_sales | 按日期或状态筛选并获取近期订单和销售记录。 |
record_sale | 创建销售交易,包含商品明细、使用的付款方式以及关联客户。 |
cancel_sale | 作废销售交易,并自动将商品退回库存。 |
get_daily_summary | 获取每日汇总指标,包括总收入、利润、交易笔数和热销商品。 |
客户管理
| 工具 | 描述 |
|---|---|
get_customers | 查询客户记录、未结余额和购买汇总。 |
add_customer | 创建新的客户档案。 |
update_customer | 更新联系信息和客户备注。 |
delete_customer | 删除客户记录。 |
单据和发票(账单)
| 工具 | 描述 |
|---|---|
list_documents | 获取发票、收据、退货发票和报价单,可按类型和状态筛选。 |
get_document | 获取完整的单据商品明细、客户详情和税费/VAT 计算信息。 |
create_document | 创建并开具正式发票、销售收据或报价单,包含商品明细。 |
delete_document | 永久删除发票或收据记录。 |
export_document_text | 渲染格式化的 ASCII 热敏收据/票据版式,适合打印或在聊天中显示。 |
开发
克隆代码仓库并安装依赖:
git clone https://github.com/ufhouck/chirak-mcp.git
cd chirak-mcp
npm install
npm run build
使用 STDIO 在本地运行:
export CHIRAK_API_KEY="your_api_key_here"
node dist/index.js
安全
- 所有 API 通信均通过 TLS(HTTPS)进行。
- API 凭据通过服务器端的 SHA-256 哈希匹配进行验证。
- 请求严格限制在隔离的租户数据库分区内。
隐私政策
Chirak 重视开发者和用户的隐私。与此 MCP 服务交互时:
- AI 客户端与 Chirak Cloud API 之间传输的所有数据均通过 TLS 加密。
- Store 数据库分区按租户 ID 严格隔离。
- API 密钥在服务器端通过 SHA-256 哈希验证,绝不会以明文存储。
- 完整的隐私政策文档:https://chirak.app/privacy
许可证
MIT 许可证。详情请参阅 LICENSE。
评论
支持 Markdown
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。