design_codehop
Design CODEHOP hybrid oligos from a block of aligned PROTEIN - for homologues too diverged for nucleotide-level design to see at all.
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": {
"table": "<table>"
},
"name": "design_codehop"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | the codon-usage table to back-translate the clamp through, BY NAME as the Codon Usage panel lists it. REQUIRED and deliberately without a default: a CODEHOP designed under the wrong organism's usage is wrong in a way nothing downstream can detect, so picking one here would silently pick a host (§1). | |
| _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. | |
| strand | No | which strand to design on. `both` returns forward and reverse sets, which is what a PCR needs. | both |
| max_run | No | longest single-base run allowed; 2003's stated polynucleotide run limit. A primer exceeding it is rejected. In nt. Advanced. | |
| _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. | |
| clamp_tm | No | target melting temperature for the non-degenerate 5' clamp (Rose 2003 step 8: "the current default is 60 °C, which usually provides a clamp of ~20 nucleotides"), measured as nearest-neighbour Tm in the buffer `conditions` names. In °C. | |
| alignment | No | the ALIGNED PROTEIN rows, each { name, sequence } in one-letter amino acids with gaps preserved - wire an upstream protein alignment here. At least 3 sequences: the clamp is a CONSENSUS, and two have none worth the name. | |
| weighting | No | how the alignment's rows are weighted before the core's consensus is read. Values: pb (Position-based (Henikoff & Henikoff 1994)), none (None — every row counts once). Advanced. | pb |
| conditions | No | salt, magnesium, dNTP and oligo concentrations plus the salt-correction method and any additives the clamp Tm is measured in. Left unset it is filled from your reaction-conditions settings, and falls back to pydna's Taq defaults (SantaLucia & Hicks 2004 table, 250 nM primer, Owczarzy 2008 salt correction) when there are none. Advanced. | |
| base_cutoff | No | minimum predicted probability for a base to enter the degenerate core. Advanced. | |
| block_index | No | which gapless block to design in, 0-based, ordered as `gaplessBlocks` returns them (blocks of at least 8 ungapped columns). Unset = the first. | |
| core_lengths | No | core lengths the scan tries, in residues — every length here is scanned and the best-scoring core kept. Advanced. | |
| alignment_fasta | No | an aligned PROTEIN FASTA, when there is no upstream alignment to wire. | |
| genetic_code_id | No | NCBI `transl_table` id for the codon-to-residue map. Advanced. | |
| max_clamp_length | No | ceiling on clamp growth, so an unreachable Tm REFUSES instead of consuming the whole block. Ours, and a stop condition rather than a published criterion - 40 nt is already twice the ~20 the paper expects. In nt. Advanced. | |
| max_core_degeneracy | No | degeneracy ceiling for the 3' core (Rose 2003 step 7: "a maximum degeneracy of 128"). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | which codon table the clamp was back-translated through, named so a design is never unattributable | |
| forward | Yes | the first forward oligo, clamp + core | |
| primers | Yes | the designed oligos: each with its degenerate 3' core, its consensus 5' clamp, the residues it covers and its degeneracy | |
| reverse | Yes | the first reverse oligo | |
| blockCount | Yes | how many gapless blocks the alignment offers, so a caller can see there were others to choose | |
| rejections | Yes | why each candidate position was rejected - degeneracy, run length, or a clamp that could not reach the Tm | |
| primerCount | Yes | how many oligos were designed |