rcsb_describe_seqcoord_object
Discover the available fields on Sequence Coordinates objects from the live schema, with verified dotted paths ready for the fields= argument of rcsb_seqcoord_* tools.
Instructions
Discover the fields available on a Sequence Coordinates object, from the live schema.
The Sequence Coordinates analogue of rcsb_describe_data_object, with the same shape: the
rcsb_seqcoord_* tools return a compact default selection; use this to find what else you can
request via their fields= argument. Every path it returns is
verified against the live schema, so it is safe to pass to fields= directly.
Browse a level (default), drill in / scope with into, or raise max_depth to flatten the
tree into dotted paths and filter with query. This schema is small and only 3 levels deep
(~20-31 fields per object), so max_depth=3 returns an object in full in ONE call:
rcsb_describe_seqcoord_object("alignments", max_depth=3) -> pick paths -> call
rcsb_seqcoord_alignments(..., fields="target_alignments{ ... }").
Each returned field has path (dotted, ready for fields=), kind ("scalar" leaf or "object"),
type, list (whether it's a list), and description (when present).
Args: object_key: A Sequence Coordinates root field. (alignments and group_alignments share the SequenceAlignments type; the annotation roots share SequenceAnnotations.) into: Optional dot-path of nested object field(s) to scope to, e.g. "target_alignments" or "features.feature_positions". query: Optional case-insensitive keyword, matched against each field's path (relative to the scope) and its description. max_depth: How many levels to walk (1-6, default 1 = this level only). The schema bottoms out at 3.
Returns: {object_key, graphql_type, path, query, max_depth, field_count, fields:[{path, kind, type, list, description}], truncated?, note?}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| into | No | ||
| query | No | ||
| max_depth | No | ||
| object_key | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||