changedInput schema / properties / canvas_id / description
Previous value: -"Optional canvas ID from a prior call, to reuse the same canvas. Reusing it REPLACES (overwrites) the clinvar_variants table with this call's results — it does not append. Omit to start a fresh canvas; the response returns a new one."New value: +"Optional canvas ID from a prior call, to reuse the same canvas. When supplied, each search writes its window to the clinvar_variants table on that canvas, replacing (not appending to) the previous one — even when the window fits inline; a window with no rows removes the table. An Ensembl gene ID searches nothing and leaves the canvas as it was. Omit to stage on a fresh canvas only when the window is too large to inline."
changedInput schema / properties / clinical_significance / description
Previous value: -"Filter by ClinVar clinical significance term (e.g. pathogenic, likely_pathogenic, benign)."New value: +"Filter by ClinVar clinical significance term (e.g. pathogenic, likely_pathogenic, uncertain significance), matched as whole words; underscores read as spaces. Blank means no filter."
addedInput schema / properties / limit
Added value: +{
+ "default": 500,
+ "description": "ClinVar records to fetch in this window (1–500). Counted before the clinical_significance and min_review_stars filters, so a window can return fewer rows.",
+ "maximum": 500,
+ "minimum": 1,
+ "type": "integer"
+}
addedInput schema / properties / offset
Added value: +{
+ "default": 0,
+ "description": "Zero-based position of the first ClinVar record in this window. Pass next_offset from the previous call to continue.",
+ "maximum": 2147483647,
+ "minimum": 0,
+ "type": "integer"
+}
changedOutput schema / anyOf
Previous value: -[
- {
- "not": {
- "required": [
- "error"
- ]
- },
- "required": [
- "preview",
- "canvas_id",
- "table_name",
- "spilled",
- "total"
- ]
- },
- {
- "required": [
- "error"
- ]
- }
-]New value: +[
+ {
+ "not": {
+ "required": [
+ "error"
+ ]
+ },
+ "required": [
+ "preview",
+ "canvas_id",
+ "table_name",
+ "spilled",
+ "total",
+ "total_found",
+ "truncated",
+ "next_offset",
+ "unavailable_ids"
+ ]
+ },
+ {
+ "required": [
+ "error"
+ ]
+ }
+]
changedOutput schema / properties / canvas_id / description
Previous value: -"Canvas ID — pass to gnomad_dataframe_query. Empty string when canvas is disabled."New value: +"Canvas holding table_name (or the canvas_id you supplied) — pass it to gnomad_dataframe_describe, then gnomad_dataframe_query. Empty when this call used no canvas: the window fit inline and no canvas_id was supplied, the gene was an Ensembl ID (nothing was searched), or the canvas is disabled."
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `ncbi_unreachable`: NCBI E-utilities is unreachable or rate-limited. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `upstream_unavailable`: NCBI E-utilities is unreachable, failing, or rate-limiting after retries. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "ncbi_unreachable"
-]New value: +[
+ "upstream_unavailable"
+]
addedOutput schema / properties / next_offset
Added value: +{
+ "description": "offset for the next window; null when this window reaches the end.",
+ "type": [
+ "number",
+ "null"
+ ]
+}
changedOutput schema / properties / notice / description
Previous value: -"Guidance when no ClinVar records matched, or when the canvas is disabled and the preview is capped."New value: +"Guidance on completeness (the offset that continues the list, or an offset past the end), no-match results, a capped preview when the canvas is disabled, the staged table with its next steps (gnomad_dataframe_describe, then gnomad_dataframe_query), and which identifier to pass to gnomad_get_variant."
changedOutput schema / properties / preview / description
Previous value: -"Inline preview rows — the immediate answer."New value: +"Inline preview rows — the immediate answer; the window's every row unless spilled."
addedOutput schema / properties / preview / items / properties / canonical_spdi
Added value: +{
+ "description": "Canonical SPDI of the variant (GRCh38, e.g. NC_000001.11:55039973:G:T); null for multi-allele records, CNVs, and records without one.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / preview / items / properties / grch38_variant_id
Added value: +{
+ "description": "gnomAD variant ID (chrom-pos-ref-alt, GRCh38) for gnomad_get_variant with the GRCh38 datasets (gnomad_r4, gnomad_r3). Set for SNVs, MNVs, and delins; null for deletions, insertions, duplications, mitochondrial variants, and multi-allele records.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / preview / items / properties / rsids
Added value: +{
+ "description": "dbSNP rsIDs (e.g. rs11591147), semicolon-joined; empty when none. One rsID can match several gnomAD variants, so prefer grch38_variant_id for gnomad_get_variant.",
+ "type": "string"
+}
changedOutput schema / properties / preview / items / required
Previous value: -[
- "clinvar_variation_id",
- "accession",
- "title",
- "obj_type",
- "clinical_significance",
- "review_status",
- "gold_stars",
- "last_evaluated",
- "molecular_consequences",
- "protein_change",
- "conditions",
- "submission_count"
-]New value: +[
+ "clinvar_variation_id",
+ "accession",
+ "title",
+ "obj_type",
+ "clinical_significance",
+ "review_status",
+ "gold_stars",
+ "last_evaluated",
+ "molecular_consequences",
+ "protein_change",
+ "conditions",
+ "submission_count",
+ "canonical_spdi",
+ "rsids",
+ "grch38_variant_id"
+]
changedOutput schema / properties / spilled / description
Previous value: -"True when the full result was staged on the canvas beyond the preview."New value: +"True when this window's rows exceeded the inline preview budget, so the preview holds only the first rows and table_name holds them all."
changedOutput schema / properties / table_name / description
Previous value: -"Canvas table holding the full set (clinvar_variants); empty when not spilled."New value: +"Canvas table this call staged (clinvar_variants), holding this window's rows — inspect it with gnomad_dataframe_describe, then query it with gnomad_dataframe_query. Empty when this call staged no table."
changedOutput schema / properties / total / description
Previous value: -"Total matching ClinVar records (staged row count when spilled, else preview length)."New value: +"Rows in this window that passed the filters, including any beyond the preview."
addedOutput schema / properties / total_found
Added value: +{
+ "description": "ClinVar records matching the gene and filter terms across every window, counted before the post-fetch significance and star filters.",
+ "type": "number"
+}
addedOutput schema / properties / truncated
Added value: +{
+ "description": "True when ClinVar records remain past this window; continue with next_offset.",
+ "type": "boolean"
+}
addedOutput schema / properties / unavailable_ids
Added value: +{
+ "description": "VariationIDs in this window that ClinVar returned no summary for, so they have no row; empty when none.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}