关于 devtu-code-optimization
面向 ToolUniverse 工具开发与维护的代码优化技能,提供提交前检查清单、常见缺陷分类及 API 与代码模式参考。
主要功能
- 01提交前检查清单
- 02按信号分类常见缺陷
- 03提供 API 修复参考
- 04提供可复用代码模式
- 05涵盖 Git 与 PR 流程
适用场景
- 01提交 ToolUniverse 代码前核对
- 02排查工具返回结果或 Schema 问题
- 03修复 API 调用与异常处理缺陷
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ mims-harvard/ tooluniverse --skill devtu-code-optimization安装后在 Claude Code 中输入/devtu-code-optimization确认已加载。
附带文件references/api-fixes.mdreferences/code-patterns.md
详细介绍
ToolUniverse 代码优化
编写或修改代码后,始终运行 Skill(skill="simplify")。
提交前检查清单
-
return_schema包含oneOf: [{data+metadata}, {error}] - 测试示例使用真实 ID(不要使用 DUMMY/PLACEHOLDER)
-
try:和except:的缩进级别完全一致 - JSON 中没有尾随逗号(
python3 -c "import json; json.load(open('f.json'))") - 新工具类已在
_lazy_registry_static.py和default_config.py中注册 -
ruff check src/tooluniverse/<file>.py通过 -
python -c "from tooluniverse.<module> import <Class>"通过 -
python -m tooluniverse.cli run <Tool> '<real_args_json>'返回预期数据 - 已对所有修改的文件运行
Skill(skill="simplify")
关键修复类别
| 类别 | 信号 | 参考 |
|---|---|---|
| 参数被静默忽略 | API 接受参数,但丢弃筛选条件 | code-patterns.md — 客户端筛选 |
| API 字段/端点错误 | 返回 0 条结果或 404 | api-fixes.md — 快速查询表 |
| Schema 无效 | 类型为 null、缺少 oneOf | code-patterns.md — Schema 模式 |
| 规范化行为未披露 | 自动转换对用户隐藏 | code-patterns.md — 规范化行为披露 |
| try/except 缩进 | 运行时出现 SyntaxError | code-patterns.md — try/except 部分 |
| 截断信息隐藏过深 | 数据条数隐藏在备注中 | code-patterns.md — 截断 |
| 托管模型 API(NIM) | 轮询时异步返回 404、输出被 JSON 包装、200 但内部失败、“not found for account” | code-patterns.md — 托管模型 API 工具 |
| R 子进程工具 | Rscript -e 出现 '\.' unrecognized escape | code-patterns.md — R 子进程工具 |
参考资料
- references/api-fixes.md — 各 API 的错误修复(GtoPdb、CIViC、GTEx、ENCODE、CPIC 等)
- references/code-patterns.md — 可复用的 Python 模式(Schema、筛选、分页、规范化)
Git 与 PR 工作流
git fetch origin && git stash && git rebase origin/main && git stash pop
git push --force-with-lease origin fix/round-XX-bugs
gh pr view <N> --json mergeable # must be MERGEABLE before done
- 不要直接推送到
main - 不要同时保留多个未关闭的修复 PR
- 提交消息使用“Feature”或“Fix”,不要使用“Bug”
- 提交中不要注明 AI 署名
- 仓库:
mims-harvard/ToolUniverse— 使用git remote -v验证
评论
支持 Markdown