API助手
- 作者仓库星标 1
- 作者更新于 实时读取
- 作者仓库 workbuddy
- 领域
- 通用
- 兼容 Agent
-
- Claude Code
- Cursor
- Cline
- Codex
- Windsurf
- Gemini CLI
- +20
- 信任分
- 92 / 100 · 已通过审计
- 作者 / 版本 / 许可
- @zhizhunbao · v1.0 · 未声明 license
- Token 消耗评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部 API Key
- 不需要
- 兼容的系统
- 未声明(默认跨平台)
- 底层运行要求
- 无特殊要求
- 文件与系统权限
-
- 只读
- 允许写入 / 修改
- 网络行为
- 允许外网请求
- 安装命令数
- 26 条
档案由构建时根据 SKILL.md 与安装命令自动衍生,可能与作者实际意图存在差异。
需要注意: 未限定 allowed-tools,默认拥有全部工具权限。
---
name: tapd-openapi
description: TAPD OpenAPI 调用。用于需求、缺陷、任务、迭代、Wiki 搜索等 TAPD 平台操作。 if [ -n "$TAPDWORKSPACEIDS" ]; then WSLIST=$(e…
category: 通用
runtime: 无特殊运行时
---
# tapd-openapi 输出预览
## PART A: 任务判断
- 适用问题:通用任务拆解、检查和交付。
- 输入要求:目标材料、限制条件、期望输出和验收方式。
- 证据边界:围绕“环境变量(已预置) / Workspace 处理规则 / 请求模板”读取原文规则,不把推断写成作者承诺。
## PART B: 执行结果
- **01** 任务判断:确认你的需求是否属于通用任务拆解、检查和交付,并标出输入、限制和预期结果。
- **02** 执行计划:优先按“环境变量(已预置) / Workspace 处理规则 / 请求模板”拆成步骤,说明每一步会读取什么、修改什么、产出什么。
- **03** 交付结果:给出可复制的命令、文件改动、检查清单或内容草稿,并说明如何继续迭代。
- **04** 风险边界:结合 读取文件、写入/修改文件、会按任务需要访问外部网络、通常不需要额外 API Key 给出执行前确认项。
## Running Rules
- 读取文件、写入/修改文件;会按任务需要访问外部网络;通常不需要额外 API Key。
- 先小样例验证,再放大到真实任务。
- 交付时同时给结果、检查口径和下一步迭代建议。 先确认触发方式
原文没有稳定的斜杠命令要求。安装验证后通常全局生效,直接在对话里点名这个 Skill 并描述任务即可。
给清楚输入和边界
告诉 Agent 目标文件或材料、期望结果、不可改范围、是否允许联网或执行命令。本 Skill 的权限画像是:读取文件、写入/修改文件。
小样例验证后再放大
先用一个小任务确认它会围绕“环境变量(已预置) / Workspace 处理规则 / 请求模板”工作;涉及文件或命令时,先看 diff、日志、预览或测试结果。
复核后再交付
检查最终产物是否包含明确结果、必要证据和下一步动作;如果输出泛泛而谈,就补充输入、边界和验收标准后重跑。
---
name: tapd-openapi
description: TAPD OpenAPI 调用。用于需求、缺陷、任务、迭代、Wiki 搜索等 TAPD 平台操作。 if [ -n "$TAPDWORKSPACEIDS" ]; then WSLIST=$(e…
category: 通用
source: zhizhunbao/workbuddy
---
# tapd-openapi
## 什么时候使用
- | 服务 | 说明 | 常用 API 文件 | 适合处理通用任务拆解、检查、交付和复盘,核心价值是把输入、判断、执行、验证和交付边界固定下来,避免 Agent 泛泛回答。 把任务拆成可执行、可检查、可继续迭代的步骤;通常不需要额外 AP…
- 面向通用任务拆解、检查和交付,优先处理能明确输入、步骤和验收标准的工作。
## 需要提供什么
- 目标材料、目录范围、期望结果和不可改动内容。
- 是否允许联网、执行命令、读写文件或调用外部服务。
## 执行规则
- 围绕「环境变量(已预置) / Workspace 处理规则 / 请求模板」组织步骤,不把推断写成作者事实。
- 读取文件、写入/修改文件;会按任务需要访问外部网络;通常不需要额外 API Key。
- 先跑小样例,确认结果可检查后再扩大任务范围。
## 输出要求
- 给出最终产物、关键证据、验证方式和下一步动作。
- 信息不足时标记 unknown,不编造命令、平台或依赖。 证据边界与执行链路
作者原文负责流程事实;仓库文件负责来源和命令;流狐只补充适用场景、限制和质量判断。
skill "tapd-openapi" {
输入层 -> 用户目标 + 目标文件 + 禁止范围 + 验收标准
上下文层 -> 环境变量(已预置) / Workspace 处理规则 / 请求模板
规则层 -> SKILL.md 触发条件 / 执行顺序 / 输出格式
运行层 -> 无特殊运行时 | 读取文件、写入/修改文件 | 会按任务需要访问外部网络
安全层 -> 通常不需要额外 API Key + 小任务验证 + diff / 日志复核
输出层 -> 可复制结果 + 检查清单 + 下一步迭代
} TAPD OpenAPI
环境变量(已预置)
TAPD_API_ENDPOINT- API 地址, 如果TAPD_API_ENDPOINT已配置,则优先使用TAPD_API_ENDPOINT的替换文档中的${TAPD_API_ENDPOINT}TAPD_WORKSPACE_IDS- 项目 ID 列表,逗号分隔,优先级高于TAPD_WORKSPACE_IDTAPD_WORKSPACE_ID- 单个项目 ID(兼容旧配置)TAPD_TOKEN- 认证 Token(Bearer 方式)
Workspace 处理规则
调用前必须先确定实际使用的 workspace 列表:
# 优先取 TAPD_WORKSPACE_IDS,回退到 TAPD_WORKSPACE_ID
if [ -n "$TAPD_WORKSPACE_IDS" ]; then
WS_LIST=$(echo "$TAPD_WORKSPACE_IDS" | tr ',' ' ')
else
WS_LIST="$TAPD_WORKSPACE_ID"
fi
- 若
WS_LIST只有一个 ID,按单 workspace 正常请求即可 - 若有多个 ID,需对每个 ID 分别调用 API,再汇总结果(求和、合并列表等,根据用户意图决定)
- 注意 curl 的时候 workspace_id 用逗号分隔后的,例如 $TAPD_WORKSPACE_IDS 是 "31372104,68119668",则 curl 的时候需要分别调用
workspace_id=31372104和workspace_id=68119668
请求模板
# GET
curl -s -H "Authorization: Bearer $TAPD_TOKEN" \
"${TAPD_API_ENDPOINT}/${path}?workspace_id=${ws_id}"
# POST
curl -s -X POST -H "Authorization: Bearer $TAPD_TOKEN" \
-H "Content-Type: application/json" \
"${TAPD_API_ENDPOINT}/${path}" \
-d '{"workspace_id":"'"${ws_id}"'","key":"value"}'
查询 API 文档
API 文档位于 ~/.codebuddy/skills/tapd-openapi/references/ 目录。
1. 列出所有服务:
ls ~/.codebuddy/skills/tapd-openapi/references/
2. 列出服务下的 API:
ls ~/.codebuddy/skills/tapd-openapi/references/stories/
3. 查看 API 详情:
cat ~/.codebuddy/skills/tapd-openapi/references/stories/liststories.md
常用服务
| 服务 | 说明 | 常用 API 文件 |
|---|---|---|
| stories | 需求管理 | liststories, countstories, addstory, updatestory, getrelatedbugs, getstoryfieldsinfo |
| bugs | 缺陷管理 | listbugs, countbugs, addbug, updatebug, getbugfieldsinfo |
| iterations | 迭代管理 | listiterations |
| tasks | 任务管理 | listtasks, counttasks, addtask, updatetask |
| comments | 评论管理 | listcomments, countcomments, addcomment |
| wikis | Wiki 管理 | listwikis, countwikis, addwiki, updatewiki, searchwiki(见下方) |
| timesheets | 工时花费 | listtimesheets, counttimesheets, addtimesheet, updatetimesheet |
| attachments | 附件管理 | listattachments, downloadattachment, getimage, downloaddocument |
| users | 用户信息 | getuserinfo, listworkspaces |
调用流程
- 确定服务:根据需求从常用服务中选择,或用
ls查看全部 - 查找 API:用
ls ~/.codebuddy/skills/tapd-openapi/references/{服务}/找到具体操作 - 获取详情:用
cat读取 API 文档,获取请求方法、路径、参数 - 执行请求:按模板构造 curl 命令,
workspace_id必传
Wiki 搜索
TAPD API 不支持 Wiki 全文搜索,通过本地脚本实现。详见:
cat ~/.codebuddy/skills/tapd-openapi/references/wikis/searchwiki.md
先判断是否适合
作者设计意图
作者的方法与取舍
边界和复核