longbridge

Official

by longbridge

Overview Schema Source Related Servers Discussions(1)Admin

Rust

Hybrid

Rank List

rank_list

Read-onlyIdempotent

Retrieve ranked stock lists by leaderboard tab keys for US/HK markets, with optional market override, result size, and related news inclusion.

Instructions

Get ranked stock list by leaderboard tab key. key: from rank_categories second_tags[].key (e.g. "hot_all-us", "hot_up-hk", "trade_heat-us"). market: inferred from key suffix (-us/-hk) or pass explicitly. size: results (default 20).

Input Schema

TableJSON Schema

Name	Required	Description
`_jq`	No	Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the `env`/`debug`/`stderr` builtins are unavailable. Example: .data \| map({symbol}). Omit for the full response.
`key`	Yes	Tab key from rank_categories second_tags[].key, e.g. "hot_all-us" (US total heat), "hot_up-hk" (HK rising heat), "trade_heat-us" (US hot trades). The "ib_" prefix is stripped from rank_categories keys and added back automatically.
`size`	No	Number of results to return (default: 20)
`market`	No	Market override: "US" \| "HK" \| "CN" \| "SG". Defaults to the market suffix in the key (e.g. "ib_hot_all-hk" → HK), then "US".
`need_article`	No	Whether to include related news articles (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.12.0Sep 23, 2026

addedInput schema / properties / _jq / description

Added value: +"Optional jq filter (jaq syntax) applied to this tool's JSON response before it is returned; it never changes the upstream request. One output is returned as-is, several as a JSON array, none as []. Module imports and the `env`/`debug`/`stderr` builtins are unavailable. Example: .data | map({symbol}). Omit for the full response."

removedInput schema / properties / size / format
```
Removed value: -"uint32"
```

Changed2 schema fields changedv0.10.6Sep 10, 2026

addedInput schema / properties / _jq
```
Added value: +{
+  "type": "string"
+}
```

changedOutput schema / (root)

Previous value: -{
-  "$defs": {
-    "RankListItem": {
-      "properties": {
-        "amplitude": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "chg": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "five_day_chg": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "industry": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "inflow": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "intro": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "last_done": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "market_cap": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "name": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "pre_post_chg": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "pre_post_price": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "symbol": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "ten_day_chg": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "this_year_chg": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "turnover_rate": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "twenty_day_chg": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "volume_rate": {
-          "type": [
-            "string",
-            "null"
-          ]
-        }
-      },
-      "type": "object"
-    }
-  },
-  "properties": {
-    "lists": {
-      "items": {
-        "$ref": "#/$defs/RankListItem"
-      },
-      "type": [
-        "array",
-        "null"
-      ]
-    },
-    "updated_at": {
-      "type": [
-        "string",
-        "null"
-      ]
-    }
-  },
-  "type": "object"
-}New value: +null

Changed1 schema field changedv0.7.1Jun 26, 2026
- removedInput schema / title
```
Removed value: -"RankListParam"
```
Changed22 schema fields changedv0.6.0Jun 26, 2026
- removedOutput schema / $defs / RankListItem / properties / amplitude / description
```
Removed value: -"Intraday amplitude."
```
- removedOutput schema / $defs / RankListItem / properties / chg / description
```
Removed value: -"Price change (decimal ratio)."
```
- removedOutput schema / $defs / RankListItem / properties / five_day_chg / description
```
Removed value: -"5-day price change (decimal ratio)."
```
- removedOutput schema / $defs / RankListItem / properties / industry / description
```
Removed value: -"Industry/sector name."
```
- removedOutput schema / $defs / RankListItem / properties / inflow / description
```
Removed value: -"Net capital inflow."
```
- removedOutput schema / $defs / RankListItem / properties / intro / description
```
Removed value: -"Short company introduction."
```
- removedOutput schema / $defs / RankListItem / properties / last_done / description
```
Removed value: -"Latest traded price."
```
- removedOutput schema / $defs / RankListItem / properties / market_cap / description
```
Removed value: -"Total market capitalization."
```
- removedOutput schema / $defs / RankListItem / properties / name / description
```
Removed value: -"Display name of the security."
```
- removedOutput schema / $defs / RankListItem / properties / pre_post_chg / description
```
Removed value: -"Pre-/post-market price change (decimal ratio)."
```
- removedOutput schema / $defs / RankListItem / properties / pre_post_price / description
```
Removed value: -"Pre-/post-market price."
```
- removedOutput schema / $defs / RankListItem / properties / symbol / description
```
Removed value: -"Security symbol, e.g. \"700.HK\"."
```
- removedOutput schema / $defs / RankListItem / properties / ten_day_chg / description
```
Removed value: -"10-day price change (decimal ratio)."
```
- removedOutput schema / $defs / RankListItem / properties / this_year_chg / description
```
Removed value: -"Year-to-date price change (decimal ratio)."
```
- removedOutput schema / $defs / RankListItem / properties / turnover_rate / description
```
Removed value: -"Turnover rate."
```
- removedOutput schema / $defs / RankListItem / properties / twenty_day_chg / description
```
Removed value: -"20-day price change (decimal ratio)."
```
- removedOutput schema / $defs / RankListItem / properties / volume_rate / description
```
Removed value: -"Volume ratio versus average."
```
- removedOutput schema / $schema
```
Removed value: -"https://json-schema.org/draft/2020-12/schema"
```
- removedOutput schema / description
```
Removed value: -"Returned by `rank_list`. Wraps a `lists` array of ranked stocks for a\nleaderboard tab, plus a refresh time. Subset of the wire response."
```
- removedOutput schema / properties / lists / description
```
Removed value: -"Ranked stock entries."
```
- removedOutput schema / properties / updated_at / description
```
Removed value: -"Last refresh time (RFC3339)."
```
- removedOutput schema / title
```
Removed value: -"RankListResponse"
```

Changed1 schema field changedv0.5.6Jun 12, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$defs": {
+    "RankListItem": {
+      "properties": {
+        "amplitude": {
+          "description": "Intraday amplitude.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "chg": {
+          "description": "Price change (decimal ratio).",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "five_day_chg": {
+          "description": "5-day price change (decimal ratio).",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "industry": {
+          "description": "Industry/sector name.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "inflow": {
+          "description": "Net capital inflow.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "intro": {
+          "description": "Short company introduction.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "last_done": {
+          "description": "Latest traded price.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "market_cap": {
+          "description": "Total market capitalization.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "name": {
+          "description": "Display name of the security.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "pre_post_chg": {
+          "description": "Pre-/post-market price change (decimal ratio).",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "pre_post_price": {
+          "description": "Pre-/post-market price.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "symbol": {
+          "description": "Security symbol, e.g. \"700.HK\".",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "ten_day_chg": {
+          "description": "10-day price change (decimal ratio).",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "this_year_chg": {
+          "description": "Year-to-date price change (decimal ratio).",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "turnover_rate": {
+          "description": "Turnover rate.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "twenty_day_chg": {
+          "description": "20-day price change (decimal ratio).",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "volume_rate": {
+          "description": "Volume ratio versus average.",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "Returned by `rank_list`. Wraps a `lists` array of ranked stocks for a\nleaderboard tab, plus a refresh time. Subset of the wire response.",
+  "properties": {
+    "lists": {
+      "description": "Ranked stock entries.",
+      "items": {
+        "$ref": "#/$defs/RankListItem"
+      },
+      "type": [
+        "array",
+        "null"
+      ]
+    },
+    "updated_at": {
+      "description": "Last refresh time (RFC3339).",
+      "type": [
+        "string",
+        "null"
+      ]
+    }
+  },
+  "title": "RankListResponse",
+  "type": "object"
+}

Addedv0.4.5May 28, 2026

TDQS

A3.6/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds valuable behavioral details beyond those annotations: market is inferred from the key suffix, the ib_ prefix is stripped/added automatically, and size defaults to 20. This gives an agent the operational context needed to call the tool correctly.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences deliver the core purpose, parameter sources, examples, and defaults with zero filler. The most important information (what the tool returns and how to identify the key) is front-loaded. Every sentence earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with moderate complexity (5 params, 1 required), the description covers the key workflow: where to get the key, how market is inferred, and default size. There is no output schema, so return format is not documented, but the operation is a read-only list retrieval and the invocation path is well specified. Minor gaps like pagination or output structure prevent a perfect score.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description largely repeats the schema's key, market, and size semantics rather than adding new meaning. It serves as a useful summary but does not compensate for or extend the structured parameter documentation meaningfully.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'Get ranked stock list by leaderboard tab key.' It provides concrete examples of valid keys, making the tool's function unambiguous. However, it does not explicitly distinguish itself from sibling ranking tools like industry_rank or valuation_rank, though the leaderboard-tab-key concept is fairly unique.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains how to construct parameters (e.g., market inferred from key suffix) and points to rank_categories as the source of keys, which hints at a workflow. Yet it never states when to choose this tool over alternatives such as top_movers, industry_rank, or screener_search. No explicit exclusions or comparison conditions are provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Rank List

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools