design_knockout_package
The complete build package for a knockout or knock-in, as one object: guides inside the target, an off-target census for the chosen one within this molecule, a repair template with real homology arms, a screening PCR whose primers sit OUTSIDE the arms, the protocol in order, the fragments and oligos to buy, and every coordinate ready for the map.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"target_start": "<target_start>",
"target_end": "<target_end>",
"arm_length": "<arm_length>",
"screen_flank": "<screen_flank>"
},
"name": "design_knockout_package"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| guides | No | how many guides to carry into the package, best-scoring first. The rest are the alternatives, not filler. | |
| insert | No | sequence to place at the cut (a tag, a selection cassette). Leave empty for a scarless rejoin — the package then WARNS that the two screening products are the same length. | |
| subject | No | the molecule to edit — wire a record or name a library document; leave unset to edit the open record. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| nuclease | No | the nuclease (PAM + spacer length) to scan the target for. Values: SpCas9 (SpCas9: NGG (3')), SpCas9-NG (SpCas9-NG: NG (3')), SpG (SpG: NGN (3')), SpRY (SpRY: NRN (3')), xCas9 (xCas9: NG (3')), SaCas9 (SaCas9: NNGRRT (3')), SaCas9-KKH (SaCas9-KKH: NNNRRT (3')), AsCas12a (AsCas12a: TTTV (5')), LbCas12a (LbCas12a: TTTV (5')), enAsCas12a (enAsCas12a: TTTV (5')). | SpCas9 |
| primer_tm | No | target melting temperature for the screening primers [°C] — follows your polymerase and buffer. In °C. Advanced. | |
| arm_length | Yes | homology-arm length on EACH side of the cut, in bp. A protocol decision that follows the delivery method, so there is no default: state what yours needs. The published working range is 100-800 (100-400 nt synthetic, up to ~800 bp cloned). In bp. | |
| target_end | Yes | end of the gene to knock out (0-based, exclusive). In bp. | |
| insert_name | No | what the insert is called in the protocol and on the order form. | |
| target_name | No | what the target is called, so every mark, primer and order line names its subject. | target |
| screen_flank | Yes | how far OUTSIDE the arms the screening primers must bind, in bp. Not decoration: a primer inside the arms amplifies the repair template as readily as the locus, so the assay cannot tell an edited colony from plasmid carry-over. In bp. | |
| target_start | Yes | start of the gene to knock out (0-based, inclusive). In bp. | |
| max_mismatches | No | mismatch ceiling for the off-target search within this molecule. Advanced. | |
| replace_target | No | replace the WHOLE target region with the insert, arms flanking the target — the gene-replacement donor. Off (default): the arms sit on the cut and the target's own sequence is kept on both sides of the insert (a point insertion), so this must be ON to knock one CDS in for another. Empty insert + this = a clean deletion of the target. Advanced. | |
| restriction_enzymes | No | cloning enzymes whose recognition site must NOT appear in a spacer. Advanced. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| donor | Yes | the repair template: both arms with their genomic spans, the insert, and the junctions to sequence across | |
| marks | Yes | every span this package names, ready for the map | |
| order | Yes | the fragments and oligos to buy, each with the design decision it comes from | |
| steps | Yes | the protocol in the order it is done | |
| chosen | Yes | the guide the package was built around | |
| guides | Yes | every guide inside the target, scored, best first | |
| record | Yes | the repair template as a sequence record, so the run leaves the user holding the thing to order | |
| report | Yes | the whole package as Markdown — protocol, order form, guides, template, screening and marks — so it survives outside the transcript | |
| screening | Yes | the screening PCR: the pair, the two product lengths, and the span they cover | |
| offTargets | Yes | the off-target census for the chosen spacer WITHIN this molecule, with the scope stated |