noon 运营 API for WorkBuddy
这是从 noon 工作区剥离出的独立只读 MCP 连接器。它只包含 noon 服务账号认证、报表读取、本地缓存和运营查询,不包含选品、1688、浏览器自动化、图片、Listing 发布、广告写入或 ASN 预订。
工具
noon_connection_statusnoon_get_ordersnoon_get_order_detailsnoon_get_inventorynoon_get_product_cardnoon_get_replenishmentnoon_get_operational_alertsnoon_get_todonoon_get_sales_trafficnoon_export_report(高级白名单报表入口,最多返回100行)
全部业务能力为只读。报表导出接口只负责生成并下载 noon 报表,不修改订单、库存、价格或商品。
运行时前置条件
连接器以 stdio MCP 方式启动,mcp.json 里的启动命令是:
uvx --from noon-workbuddy-api noon-workbuddy-mcp
因此需要满足:
| 前置条件 | 说明 |
|---|---|
| WorkBuddy 客户端 | 4.24.0 及以上(本连接器使用了 auth_mode: token、token-schema.json、中英文字段,均需要该版本) |
uvx 可执行 |
由 uv 提供。未安装时:macOS / Linux 执行 curl -LsSf https://astral.sh/uv/install.sh | sh;Windows 用官方安装包。装完 uvx --version 应能正常输出。 |
| 可访问 PyPI | 首次启动会从 PyPI 解析并缓存依赖 cryptography、mcp、openpyxl。内网环境请配置镜像源。 |
| 网络可访问 noon | 需要能连通 https://noon-api-gateway.noon.partners(HTTPS,443)。 |
不需要浏览器、不需要管理员权限、不需要预装 Python(uv 会自行准备并隔离运行时)。
启动后第一次调用会初始化本地缓存目录,之后常规查询走 sqlite 缓存。
本机安装
./scripts/install-local.sh
安装后运行:
NOON_CREDENTIALS=/absolute/path/noon_credentials_sensitive.json \
NOON_DATA_DIR=/absolute/path/noon-data \
NOON_CONFIG=/absolute/path/config.json \
./.venv/bin/noon-workbuddy-check
WorkBuddy 使用根目录的 mcp.json。本机部署也可以直接把 .venv/bin/noon-workbuddy-mcp 作为 stdio MCP 命令添加到 WorkBuddy。
凭证
两种提供方式,任选其一:
- 粘贴凭证内容(推荐,云端和本机都能用):设置
NOON_CREDENTIALS_JSON为凭证 JSON 的完整内容。 连接器会在启动时把它写入<NOON_DATA_DIR>/credentials/noon_credentials.json,权限0600,随后只使用这份副本。 - 指向已有文件(仅本机模式):设置
NOON_CREDENTIALS为凭证文件的绝对路径,权限必须是0600(Windows 下必须是仅当前用户、SYSTEM 与管理员可读的 ACL)。
凭证 JSON 必须包含 key_id、private_key 和 project_code 三个字段。真实凭证、会话 Cookie、JWT、
报表下载链接和订单缓存不会进入发布 ZIP,也不会写入日志。
环境变量:
NOON_CREDENTIALS_JSON:服务账号凭证 JSON 内容,与NOON_CREDENTIALS二选一。NOON_CREDENTIALS:已有凭证文件的绝对路径,仅本机部署可用。NOON_DATA_DIR:独立缓存目录,建议权限0700,默认~/.workbuddy/noon-data。NOON_CONFIG:可选商品别名和补货参数配置。NOON_WAIT_SECONDS:单次报表等待秒数,默认 50,范围 0—60。
日期和数据口径
沙特站日期统一按 Asia/Riyadh。订单数按订单号去重,件数按非取消且非退回的商品行统计。库存使用报表最新快照;缺失不能视为零。补货建议使用日历日均销量,并明确输出缺项和滞后信息。
Metadata
Release files for noon-workbuddy-api 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| noon_workbuddy_api-1.0.1.tar.gz | 77.9 kB | Without provenance | Details for noon_workbuddy_api-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| noon_workbuddy_api-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for noon_workbuddy_api-1.0.1-py3-none-any.whl |
Total release size: 114.8 kB
Release files / noon_workbuddy_api-1.0.1.tar.gz
| Download URL | noon_workbuddy_api-1.0.1.tar.gz |
|---|---|
| Size | 77.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3a4fa91103d2365f223366cc97eaefe955d945724b58cdb755bc2fc82b114b94
|
|
BLAKE2b-256 checksum How to use checksums |
4f6f2feba3c095665a6057a4bf9cc4dd224edea2db4d8355cc72f80b07fcad7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.12
|
Release files / noon_workbuddy_api-1.0.1-py3-none-any.whl
| Download URL | noon_workbuddy_api-1.0.1-py3-none-any.whl |
|---|---|
| Size | 36.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5b98cf4161780947f12c5a9b74bafdb1cc900b28f9a916e52dfd15aa93b8bd0b
|
|
BLAKE2b-256 checksum How to use checksums |
979915ba2255adb2a0364d0e4325fbf953787503c2f64a26096c39755c7dbd36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.12
|
Security for noon-workbuddy-api 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.