Agent Skills
返回列表
BytePlan 数据平台 API

BytePlan 数据平台 API

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md，安装 @user_801e2aaa/byteplan-api。

技能介绍

要解决什么问题

在 Agent 或自动化脚本里直接对接 BytePlan 数据平台时，登录（UAT）、租户上下文、模型查询以及 DIM / LIST / LOV / LEVEL 等字段取值往往要反复查文档、拼请求。本技能把平台能力收敛成可复用的 JavaScript API 封装，让对话式工作流里能稳定完成认证与取数，而不必每次手写 HTTP 细节。

技能如何工作

调用路径采用 CLI 优先、API 回退：默认通过 byteplan-cli 执行；若未安装或执行失败，会自动尝试 npm i -g byteplan-cli 安装，仍不可用则走直接 API。不确定子命令时可用 -h / --help 查看参数。

凭证落在 ~/.byteplan/.env，登录成功后由系统维护 Token；密码含特殊字符时需用引号包裹。首次使用或 Token 无效时，技能会向用户索取手机号与密码，登录后展示当前租户信息，再进入查询与取数。

同系列的 byteplan-analysis、byteplan-excel 等技能依赖本技能提供的取数能力；函数级接口见随附的 API_REFERENCE.md。

适用边界与注意点

  • 文档明确的是 UAT 环境登录认证，生产环境行为需以平台与 CLI 实际配置为准。
  • 不要手改 .env 中的 Token；无凭证时必须走交互登录，不宜在提示词里硬编码账号。
  • 字段类型与模型权限仍受 BytePlan 租户策略约束，API 封装不能绕过平台侧鉴权。

使用场景

  • 在 Agent 工作流里先完成 BytePlan UAT 登录，再按当前租户查询业务模型并获取 DIM、LIST 等字段取值。
  • 编写自动化脚本时，需要拉取 BytePlan 模型数据并读取 LOV、LEVEL 合法值，而不想手写 Token 与 HTTP 请求。
  • 串联 byteplan-excel 或 byteplan-analysis 前，用本技能完成认证、确认租户信息并取出报表所需数据集。
  • 本机尚未配置 byteplan-cli 时，仍要在任务里登录平台并执行用户与租户相关操作，依赖 CLI 安装与 API 回退。

适合人员

  • 负责把 BytePlan 模型结果写入 Excel、Word 等报告的数据分析师，需要可重复的登录与取数接口。
  • 在 Skill 链里编排 byteplan-analysis 的数据工程师，要先处理 UAT 凭证与租户上下文。
  • 维护企业维度主数据（DIM/LIST/LOV）的 BI 开发，希望在脚本里直接读平台字段类型值而非抄接口文档。
  • 习惯用对话式工具查 BytePlan 业务数据的运营或实施同学，需要手机号登录后能查模型与用户租户信息。