describe_fields
Defines scan fields and counts rows holding values so you can check units, meaning, and aliases before quoting or filtering fields with misleading names.
Instructions
Define scan fields and count what a market's rows hold for them.
Call it before quoting or filtering on a field you have not used, because names mislead: volume is traded value rather than shares, and pct_day is a percentile rank rather than a percent change.
Each field returns its group, type, unit and meaning. note says what a reader would otherwise get wrong, range appears only where the code guarantees a hard bound, and alias_of names the row field this name reads.
rows_with_value counts this market's rows with a non-null, non-empty value. At 0 the field supports no claim here. It is null for fields the tools drop, which exist only in the published JSON. true_rows appears on boolean fields and counts the rows that are true. values appears on text and list label fields as {label: rows}, most common first, unless the market has more than 15 distinct labels. Filters can test only the text ones. These counts say what this publish holds and not why. They cannot separate a field that cannot be computed from a result where nothing qualified.
Internal fields, which are bookkeeping fields and rule names, appear only when named
in fields. fields and group together keep the named fields that are in the group.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "describe_fields"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group | No | Only the fields in this group, e.g. fundamentals. The response lists every group. | |
| fields | No | Exact field names to define, internal ones included; defaults to every public field. | |
| market | No | Market code, e.g. US, HK, JP, IN, DE. See list_markets. | US |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||