bimp-mcp-guide

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

BIMP MCP Tools Guide

BIMP MCP 工具使用指南

Use this skill when BIMP MCP tools are available to understand tool naming, data fetching patterns, and workflow recipes.
当你有可用的 BIMP MCP 工具时,可参考本指南了解工具命名规则、数据拉取模式和工作流方案。

Tool Naming Convention

工具命名规范

All tools follow
bimp_{entity}_{action}
:
ActionDescriptionExample
readListList with pagination
bimp_nomenclature_readList
readRead single by UUID
bimp_nomenclature_read
createCreate new
bimp_nomenclature_create
updateUpdate existing
bimp_nomenclature_update
deleteDelete by UUID
bimp_nomenclature_delete
readStatusesGet available statuses
bimp_salesInvoice_readStatuses
updateStatusChange status
bimp_salesInvoice_updateStatus
所有工具都遵循
bimp_{entity}_{action}
的命名规则:
操作描述示例
readList带分页的列表查询
bimp_nomenclature_readList
read按 UUID 查询单个条目
bimp_nomenclature_read
create创建新条目
bimp_nomenclature_create
update更新已有条目
bimp_nomenclature_update
delete按 UUID 删除条目
bimp_nomenclature_delete
readStatuses获取可用状态列表
bimp_salesInvoice_readStatuses
updateStatus修改状态
bimp_salesInvoice_updateStatus

Utility Tools

实用工具

bimp_fetch_all

bimp_fetch_all

Auto-paginate any readList endpoint. Handles offset, cursor, and page pagination.
json
{
  "tool": "bimp_nomenclature_readList",
  "limit": 50,
  "enrich": true,
  "filters": { "nameContains": "gel" }
}
Always use
enrich: true
for salesInvoice, specification, purchaseInvoice, production-order — their readList data is incomplete.
可为任意 readList 接口自动处理分页,支持 offset、cursor 和 page 三种分页方式。
json
{
  "tool": "bimp_nomenclature_readList",
  "limit": 50,
  "enrich": true,
  "filters": { "nameContains": "gel" }
}
对于 salesInvoice、specification、purchaseInvoice、production-order 这类资源,务必使用
enrich: true
,因为它们的 readList 接口返回的数据不完整。

bimp_batch_read

bimp_batch_read

Read multiple items by UUID in parallel.
json
{
  "tool": "bimp_nomenclature_read",
  "uuids": ["uuid1", "uuid2", "uuid3"],
  "concurrency": 10
}
可根据 UUID 并行读取多个条目。
json
{
  "tool": "bimp_nomenclature_read",
  "uuids": ["uuid1", "uuid2", "uuid3"],
  "concurrency": 10
}

bimp_bulk_update

bimp_bulk_update

Update multiple items in parallel. Works for create too.
json
{
  "tool": "bimp_nomenclature_update",
  "items": [{ "uuid": "...", "name": "New Name" }],
  "concurrency": 5
}
可并行更新多个条目,也支持创建操作。
json
{
  "tool": "bimp_nomenclature_update",
  "items": [{ "uuid": "...", "name": "New Name" }],
  "concurrency": 5
}

Extended Nomenclature Tools

扩展命名工具

For planning/accounting fields not in the standard API:
ToolPurpose
bimp_nomenclatures_read
Full product card with minStock, maxStock, speedOfDemand, etc.
bimp_nomenclatures_upsert
Create/update with planning fields
bimp_nomenclatures_readList
List all with minStock
Note: these use
/org2/nomenclatures/
(plural) — different from
/org2/nomenclature/
(singular).
用于获取标准 API 中不包含的计划/财务字段:
工具用途
bimp_nomenclatures_read
包含 minStock、maxStock、speedOfDemand 等字段的完整产品卡片
bimp_nomenclatures_upsert
携带计划字段的创建/更新操作
bimp_nomenclatures_readList
查询带 minStock 字段的全量列表
注意:这些工具使用
/org2/nomenclatures/
(复数形式)路径,和
/org2/nomenclature/
(单数形式)路径不同。

Auth Tools

鉴权工具

ToolPurpose
bimp_auth_listCompanies
List accessible companies
bimp_auth_switchCompany
Switch by code or UUID
工具用途
bimp_auth_listCompanies
查询可访问的公司列表
bimp_auth_switchCompany
通过编码或 UUID 切换公司

Common Workflows

常见工作流

Fetch All Products with Details

拉取所有产品的详细信息

bimp_fetch_all { tool: "bimp_nomenclature_readList", enrich: true }
bimp_fetch_all { tool: "bimp_nomenclature_readList", enrich: true }

Sales Analysis for a Period

某一时间段的销售分析

bimp_fetch_all {
  tool: "bimp_salesInvoice_readList",
  enrich: true,
  filters: { periodable: ["2026-01-01T00:00:00.000Z", "2026-03-31T23:59:59.000Z"] }
}
bimp_fetch_all {
  tool: "bimp_salesInvoice_readList",
  enrich: true,
  filters: { periodable: ["2026-01-01T00:00:00.000Z", "2026-03-31T23:59:59.000Z"] }
}

Check What Can Be Produced

查询可生产的商品

  1. bimp_fetch_all { tool: "bimp_specification_readList", enrich: true }
    — get BOMs
  2. bimp_nomenclature_readStocks
    — get current inventory
  3. For each spec: min(stock[component] / bom[component].quantity) = max producible units
  1. bimp_fetch_all { tool: "bimp_specification_readList", enrich: true }
    — 获取物料清单
  2. bimp_nomenclature_readStocks
    — 获取当前库存
  3. 对每个物料清单计算:min(库存[组件] / 物料清单[组件].数量) = 最大可生产数量

Mass Price Update

批量更新价格

  1. bimp_fetch_all { tool: "bimp_nomenclature_readList" }
    — get products
  2. Calculate new prices
  3. bimp_bulk_update { tool: "bimp_priceList_updatePrice", items: [...] }
  1. bimp_fetch_all { tool: "bimp_nomenclature_readList" }
    — 获取产品列表
  2. 计算新价格
  3. bimp_bulk_update { tool: "bimp_priceList_updatePrice", items: [...] }

Production Planning with Planning Fields

利用计划字段进行生产排程

  1. bimp_nomenclatures_read { uuid }
    — get minStock, speedOfDemand, deliveryTerm
  2. bimp_nomenclature_readStocks
    — current stock
  3. deficit = max(0, minStock - currentStock)
  4. Check BOMs for component requirements
  5. Create production orders for feasible items
  1. bimp_nomenclatures_read { uuid }
    — 获取 minStock、speedOfDemand、deliveryTerm 字段
  2. bimp_nomenclature_readStocks
    — 获取当前库存
  3. 缺口 = max(0, 最低库存 - 当前库存)
  4. 核对物料清单的组件需求
  5. 为可生产的商品创建生产订单

Tips

小贴士

  • Use
    bimp_fetch_all
    instead of manual pagination
  • Always
    enrich: true
    for documents with product lines
  • Filter by period with
    periodable: [start, end]
    in ISO format
  • Counterparties can be both customer (
    isCustomer
    ) and supplier (
    isSupplier
    )
  • Documents use
    EntryStatus: 0
    (Draft) /
    EntryStatus: 1
    (Posted)
  • 优先使用
    bimp_fetch_all
    替代手动分页
  • 对于带产品线的文档,始终开启
    enrich: true
  • 使用 ISO 格式的
    periodable: [开始时间, 结束时间]
    按时间段筛选
  • 交易伙伴可同时是客户 (
    isCustomer
    ) 和供应商 (
    isSupplier
    )
  • 文档使用
    EntryStatus: 0
    (草稿)/
    EntryStatus: 1
    (已过账)标记状态