urdf
GitHub用于创建、编辑和验证URDF机器人描述文件。涵盖关节、连杆、惯性及几何体建模,强调帧语义与单位一致性,提供CAD查看器集成以可视化检查模型结构。
Trigger Scenarios
Install
npx skills add earthtojake/text-to-cad --skill urdf -g -y
SKILL.md
Frontmatter
{
"name": "urdf",
"license": "MIT",
"metadata": {
"repository": "earthtojake\/text-to-cad"
},
"description": "URDF robot description authoring and validation. Use when creating, editing, inspecting, validating, or debugging `.urdf` files, robot links, joints, limits, inertials, visual\/collision geometry, mesh references, frame conventions, or robot-description artifacts. Covers the robot's structure, not MoveIt2 semantic groups or IK\/path-planning semantics (SRDF), and not the STEP\/STL\/3MF\/DXF\/GLB files its meshes come from. Open and visually review existing URDF files in CAD Viewer."
}
URDF
Use this skill for URDF robot-description outputs. Treat URDF work as constrained kinematic modeling, not just XML writing. The main correctness risks are frame placement, joint-axis semantics, unit consistency, mesh scale, and inertial data.
Setup
Run the cad command (~/.local/bin/cad where ~/.local/bin is not on your PATH, or where a
project's environment puts its own cad first; cad.cmd on Windows). If cad is not found and
the CAD app was only just added, its server may still be starting: wait five seconds and run the
command again, for up to a minute, before anything else. Otherwise install text-to-cad, outside a sandbox or with its permission:
curl -fsSL https://texttocad.dev/install.sh | sh
On Windows, in PowerShell: irm https://www.texttocad.dev/install.ps1 | iex. Any other failure
says what to do, and cad doctor explains the installation.
Core Rules
- The
.urdffile is the source of truth. Author and edit URDF XML directly; do not build a Python generation pipeline for it. - Before writing or changing URDF XML, establish the robot's frame, joint, geometry, unit, and assumption ledger and embed it as a comment block at the top of the
.urdffile. Seereferences/design-ledger.md. - Use URDF frame semantics exactly. Joint origins, link frames, joint axes, and visual/collision/inertial origins use different reference frames. See
references/frame-semantics.md. - Do not infer spatial transforms, mesh units, handedness, axes, or joint signs from vague prose. Use CAD transforms, dimensioned drawings, measured values, existing source data, or explicit documented assumptions.
- Never freehand numeric values that are the result of computation — inertia tensors, centers of mass, unit conversions across many links, mirrored transforms. Compute them: closed-form formulas for primitives, or a throwaway helper script for mesh-derived values. See
references/inertials.md. - For physical links, model
inertial,visual, andcollisionseparately when the target consumer needs them. Frame-only links may intentionally omit mass and geometry. - Validate every created or modified
.urdfwithcad urdf validatebefore reporting completion. Seereferences/validation.md. - Helper scripts are allowed and encouraged for computation, but they are scaffolding, not the artifact's source of truth. For complex or genuinely parametric models it is reasonable to keep a model-local helper script on disk next to related source code (for example STEP generator sources) and note it in the ledger; this is optional, and the checked-in
.urdfremains canonical.
Show the model
Show the user each model you create or change, and any model or file they ask to see.
A file you export is a download: give its path, do not open it.
Snapshots and validation don't replace this. Never screenshot the viewer to confirm your
own work; review with cad snapshot.
-
If your tools include
cad_show(your host may prefix it), call it with the model's id or the file's absolute path, and follow its description for when to call it again. The other tools depend on the host. A host that draws CAD cards or tabs (Claude Desktop, the Codex app) also hascad_view, which reads what the user selected, andcad_screenshot, which shows you what they see, both of a card or tab that is open, for when they ask about it. A text host (Claude Code in a terminal,codex exec) draws nothing: itscad_showopens the model's page in the user's browser and answers with the URL to give them, and it has no view to read.cad_inspect,cad_snapshotandcad_exportare on every host. Call only the tools you have, and never say a card shows a model when your host drew none. -
Otherwise give the user the page's link once: a model's page is the
view:line its run prints. For a file, run the CAD Viewer, from any folder:cad viewer --json FILE [FILE ...]The command ensures this installation's server, registers each file and prints its page,
/<id>, then exits. Read each file'surlfromdocumentsin its one JSON line (never guess the port); the URL carries its token query. A page follows every later run of its model and every rewrite of its file, so share it once. Return that link to the user. If it fails to launch, say so.
A .urdf you write is the robot's model, not an export: show it. Review mesh scale
and placement, then sweep every movable joint against the
design ledger. A link alone does not complete the viewer sweep;
report any checks you could not perform.
Workflow
- Identify the target
.urdffile and its consumers: RViz, robot_state_publisher, Gazebo/Ignition, MoveIt, a real robot driver, or another simulator. - Read or create the design ledger before editing frames, origins, axes, mesh scale, limits, or inertials. Keep the ledger as a comment block in the
.urdfitself. - Prepare mesh assets first when links reference meshes: one mesh per link, exported in that link's frame by the owning CAD/mesh workflow. See
references/meshes.md. - Author or edit the URDF XML directly, following
references/authoring-contract.mdfor structure, ordering, and naming. - Compute — never guess — inertials and other derived numbers. See
references/inertials.md. - Validate with
cad urdf validate; fix findings and re-validate until clean. - Run the verification recipe in
references/validation.md: external tools when available (check_urdf), then a viewer review sweeping every joint. - Report remaining assumptions, unchecked spatial data, and validation gaps.
Commands
Run cad as Setup defines it. cad doctor reports the installation in use and the server's release. Validation itself needs nothing beyond the Python standard library; a snapshot draws with the CAD kernel. Use cad <verb> --help for the complete current interface.
The validator shape is:
cad urdf validate path/to/robot.urdf
cad urdf validate path/to/robot.urdf --strict
cad urdf validate path/to/robot.urdf --json
cad urdf validate path/to/robot.urdf --packages robot_description=/path/to/pkg
cad snapshot path/to/robot.urdf review.png
The validator collects all findings in one pass (severity, code, XML path) across XML structure, tree topology, joint semantics (limits, mimic, dynamics), geometry, mesh references, materials, inertial physics, and misspelled elements, and prints a summary. One run validates ONE file: --strict treats warnings as failures; --json prints one line of {"ok", "path", "issues": [{"severity", "code", "message", "element", "hint"}], "summary"}, where element is the XML path; --packages NAME=PATH resolves package:// mesh URIs and repeats for several roots. It exits nonzero if the target fails. Relative targets resolve from the current working directory; run from the workspace that owns the files.
Validation is a guardrail, not spatial proof: a URDF can pass every structural check while placing a joint in the wrong spot. The ledger and viewer sweep exist for that reason.
Snapshot Tool
cad snapshot draws the robot to a PNG still, as the CAD Viewer shows it,
rendered by OCCT:
cad snapshot path/to/robot.urdf review.png
cad snapshot path/to/robot.urdf review.png --pose '{"shoulder_pitch": 30, "gripper_slide": 0.02}'
The robot opens where the CAD Viewer opens it, every joint at zero. --pose gives
joint values over that, in degrees (metres for a prismatic joint), each naming a
joint a person can drive, within its limits, or the request is refused before
anything renders: a fixed joint, a <mimic> follower or a <tcad:four_bar> input
is refused by name (a follower follows its leader, an input its driver). Each link
is placed by the viewer's own forward kinematics, mimic joints and four-bar
linkages followed, and drawn in one colour of the Parts palette.
A visual is a box, cylinder or sphere, which the server meshes itself, or a mesh
file beside the description: an STL or a 3MF (its numbers scaled by the mesh's
scale, the same on all three axes) or a GLB (metres). A package://NAME/... mesh is found
in the ROS package the description is in: the nearest folder above the .urdf named
NAME, or holding a package.xml that names it, so keep the description inside its
package folder. A mesh in another format (.dae, .obj), a remote URI, a package no
folder above the description is, or a missing file is refused by name, and a link mesh
that cannot be loaded fails the snapshot rather than leaving the link out.
A normal snapshot uses Solid mode and Light appearance. --display takes any of the
viewer's display modes (parts, xray, hidden-line, wireframe, ...),
exploded=AMOUNT, or the display object: appearance (light or dark),
camera (projection and focal length) and clip ({"clip": {"axis": "x", "at": 0.05}}, at in metres, the file's own unit, as the viewer draws it). --grid draws
the measuring grid, and --camera, --size-profile, --width and
--height frame and size it. A Quick Edit packet from the viewer (inline JSON, saved
to a temporary .snapshot.json, or its path) replays with
--annotation <packet> --camera authored, its job's jointValues given as --pose.
Inspect supplied annotations before editing. Without annotations, the captured
view is optional context; render it when useful to the request.
Link meshes are resolved relative to the description, so they must be present: an
unhydrated Git LFS pointer is not a mesh and fails the snapshot. Run
git lfs checkout <mesh dir> first.
OUT is written exactly as given and must be a .png; check the exit status before
reading it. Use cad snapshot --help for the complete current interface.
References
- Authoring contract (structure, ordering, golden skeleton):
references/authoring-contract.md - Design ledger:
references/design-ledger.md - Frame semantics:
references/frame-semantics.md - Mesh preparation and references:
references/meshes.md - Inertials (formulas, scripts, sanity gates):
references/inertials.md - URDF edit workflow:
references/urdf-workflow.md - Validation and verification recipe:
references/validation.md
Version History
-
5efa85a
Current 2026-11-02 19:25
版本0.10.0变更:统一环境管理,分发cad/cad-server/cad-mcp三个组件;简化技能调用方式,移除旧版setup指南及版本号后缀;优化脚本构建逻辑,支持通过cad run直接运行并自动安装依赖包。
-
284827c
2026-10-19 02:43
从手动安装更新为使用uv管理cadgen依赖;修复URDF网格错误、多面引用解析及Windows字体导入问题。
-
4eaf745
2026-09-22 08:14
修正了验证器关于gz_check默认值、角度警告及严格模式的说明错误;澄清了SRDF结构检查逻辑与命名空间元素处理规则;更新了CAD Viewer相关文档及命令行工具调用方式。
-
d0e4cb6
2026-09-09 02:39
cadgen 升级至 0.5.0:重构为单一分发包,引入内容寻址模型图与并行构建池,重写技能契约并优化发布流程。
-
0.4.12
2026-08-16 02:06
从Python生成管线转为直接编辑XML为真理源,引入设计账本规范,强化帧语义与惯性计算规则,增加CAD Viewer交接流程。
- 0.3.9 2026-07-24 11:54


