describe_schema
Retrieve the canonical schema for HKEX filings to understand available fields and filters. Specify a section to get only relevant details before querying.
Instructions
Use this before filtering or interpreting results to learn the canonical fields.
Use search_filings or search_documents to query filings once you know the field names.
Pass section to return just one section (saves tokens); default returns everything:
filing and document fields, the known filing types/categories/statuses/types, graph
edge kinds, and the supported query filters. Reads no filings.
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_schema"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| section | No | Narrow to one section: filing, document, types, query, or all (default). | all |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |