Tools and edits
What the assistant can look up, build and change. Every change is worked out as a proposal first, with the check results before and after. It is saved as a new revision of the project in your account, and the earlier revisions are kept.
Reading a project
| Tool | What it does |
|---|---|
| list_projects | The projects stored in your account, and how many board builds are left today |
| get_overview | Sheets, parts by type, power nets, board size and layers, check counts |
| list_components, get_component | Parts with value, footprint and fields; each pin and what it connects to; the footprint's position on the board |
| list_nets, get_net | Nets with their pins, labels and aliases |
| get_checks | ERC, DRC (clearance and board checks), schematic/PCB parity, unrouted connections |
| check_requirements | Your project's requirements (power budget, interfaces, environment), each as pass, fail or unknown (Requirements) |
| check_compatibility | Rule checks between connected parts: supply rail crossings and I²C pull-ups (Compatibility checks) |
| get_board_routing | Tracks, widths and vias per net |
| render_design | A picture of the board (front, back, both, or chosen layers) or of a schematic sheet. It also draws a proposal before it is saved |
The local server has the tools of this first table, with open_project in place of list_projects, and none of the building or changing tools below.
Every project tool takes the project's id, which list_projects gives.
The ERC, DRC and parity results are Crossprobe's own checks, tested against KiCad's (kicad-cli) on KiCad's demo projects.
Building a board
These are the tools behind Build a board from requirements.
| Tool | What it does |
|---|---|
| search_symbols, get_symbol | Find a part in the symbol libraries; its pins, datasheet link and default footprint. get_symbol also reads a .kicad_sym the assistant fetched |
| search_footprints, get_footprint | Find a footprint; its pads and size. get_footprint also reads a .kicad_mod |
| list_blocks, get_block | Crossprobe's design blocks: reference circuits whose values cite their datasheet pages |
| propose_design | Build a board from a design spec: schematic, placement, pour, routing and checks. Returns a report and a proposal; writes nothing |
| write_design | Save a built board as a project in your account, or as a new revision of the project it came from |
| get_design_spec | The spec a project was built from, to change and build again |
The report of propose_design lists ERC, DRC and parity results, unrouted connections, parts that found no room, nets routed the long way round, the result of each requirement, and notes on what the checks cannot see.
Building a design again from its spec replaces the schematic and the board. Changes made by hand since are only in the earlier revisions. To change one thing on a built board, move the part instead.
Changing a project
A change takes two steps, so that nothing is saved untested:
propose_editstries the change on a copy. You see what would change: the parts and nets affected, the ERC, DRC, parity and unrouted counts before and after, and any new issue the change would cause.apply_editssaves the proposal.
| Change | What it does |
|---|---|
| set_field | A field on a part: value, footprint (Library:Name), datasheet link, part number or any other. It is set on the board footprint too |
| no_connect | A no-connect flag on a pin that is meant to stay unused. A pin that is connected is refused |
| annotate | Number the unnumbered parts, or all of them again |
| refill_zones | Refill the board's copper zones |
| move_part | Move a footprint to a position, turn it, or both. The tracks of its nets come off and are routed again; everything else stays. A move onto another part is refused |
A move takes a second or two, where building the whole design again takes much longer and may rearrange everything. If the board was built from a design spec, the spec then keeps the part at its new position.
A new footprint from set_field is written to the schematic; run Update PCB from Schematic (F8) to place it on the board.
Saving
The assistant saves as soon as the change you asked for is worked out, as a new revision of the project. Earlier revisions are kept and nothing is overwritten. If the project was saved in between, the proposal is refused and worked out again. See Saving.
Prompts
| Prompt | What it starts |
|---|---|
| design_review | A whole design review: power, decoupling, pins, connectivity, parts, the PCB, and a triage of the automatic checks. Takes a scope and a focus |
| design_board | A board from requirements, step by step: requirements, circuit, build, look, save |