Use this first to learn the server version, configured sinks, and read sink.

Use include="config" for the raw configuration values or list_sinks for per-sink detail. include is one of: summary (server metadata only, default), sinks (also returns the list_sinks payload), or config (also returns the configuration payload) — so you can pull the summary and the detail in a single call. Returns server metadata only; it reads no filings. include="sinks" is an alias for the list_sinks payload — call list_sinks directly when sinks are the only thing you need. This tool is read-only.

Use this when the user asks which databases are configured or their capabilities.

Use get_server_info (with include="config") for the raw DATABASE_TARGET string or a one-line summary instead. Pass sink_id to inspect one sink without the full list. Returns every known sink id with its license, optional extra, configured/available status, per-sink capabilities, and which sink serves reads. Reads no filings. get_server_info with include="sinks" returns this same payload; call this tool directly when per-sink detail is all you need.

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.

Use this to list companies, or just their ticker codes, that have filings.

view="companies" (default) returns each company's ticker, name, and filing count, ordered by filing count descending (ties broken by ticker ascending). view="tickers" returns only the distinct ticker codes, alphabetically sorted and paged. ticker is a case-insensitive substring match (e.g. '0700' matches '0700.HK'). Not for a company's filings (use search_filings) or for aggregate counts (use get_statistics with group_by="company_ticker"). This tool is read-only.

Use this to find filings by ticker, type, status, date range, or title text.

Prefer search_documents for full-text search over extracted text, and get_filing or get_filings to read filings whose ids you already have. Filters are optional and combinable; comma-separate a value to match several (e.g. filing_type="Annual Report,Dividend"). document_status accepts the real statuses plus unprocessed (no document yet). document_type accepts pdf, html, xlsx, docx, or unknown, and source is a free-text origin like HKEx. date_from/date_to are YYYY-MM-DD inclusive. order_by is one of filing_date_desc (default), filing_date_asc, title_asc, filing_id_asc. Returns paged filing rows (no document text); call get_filing for the document. This tool is read-only.

Use this for full-text search over extracted document text.

Use search_filings instead to filter by metadata without a text query. Matches text_query case-insensitively inside document_text and returns filing rows with a snippet when the sink supports it (see snippets_supported). document_type accepts pdf, html, xlsx, docx, or unknown; source is a free-text origin like HKEx. All filters combine with AND semantics (a filing must match every filter you set). Returns nothing until documents are processed. This tool is read-only.

Use this to count filings grouped by one dimension, or per sink.

Choose between: this tool gives a grouped breakdown of one population (or per-sink totals when group_by="sink"); get_coverage reports scrape coverage by month; verify_sinks compares across sinks. group_by is one of: company_ticker (default), filing_type, filing_category, document_status, exchange, or sink. Optional filters narrow the population and combine with AND semantics (a filing must match every filter you set); group_by="sink" honours only ticker, filing_type, filing_category, document_status, date_from, and date_to, and returns per-sink totals (relational sinks only). top_n caps the returned buckets and min_count drops small buckets, but total still counts every matching filing. Buckets are sorted by count descending. This tool is read-only.

Use this to read one filing's metadata and extracted document content.

Returns the canonical filing and document fields. document_text is a window of max_text_chars from text_offset; when text_truncated is true, call again with next_text_offset for more. Tables (document_tables) are included only when include_tables is true. Obtain ids from search_filings. This tool is read-only.

Use this to read several filings in one call (up to 50 ids).

Use get_filing instead to read a single filing. Returns each filing's metadata plus, when include_text is true, a bounded text window. Ids not found are listed in not_found. Text is off by default. Parameter relationships: filing_ids must come from search_filings (1..50 ids); max_text_chars applies per filing and only takes effect when include_text is true; include_tables is independent of the text window. Read-only.

Use this to report scrape coverage per monthly chunk, with totals.

Use get_statistics for filing counts grouped by a dimension, or verify_sinks for cross-sink comparison. date_from/date_to (YYYY-MM-DD) filter by chunk month. limit caps how many chunks are returned, but totals always aggregate the full filtered range. Rows are newest-first. Read-only.

Use this to check that configured sinks agree on their filings.

mode="hashes" (default) compares (filing_id, document_sha256) sets across comparable sinks and returns a bounded sample of any missing/extra/mismatched ids. mode="counts" runs a faster count-only parity check, returning per-sink counts and the spread (parity is OK when the spread is zero). For a per-sink total or a grouped breakdown use get_statistics, and for monthly scrape coverage use get_coverage. Parameter relationships: sinks must list two or more comparable sink ids from list_sinks (empty compares every comparable pair); sample_size bounds the examples returned per problem bucket, not the comparison itself, and is ignored by mode="counts". This tool is read-only.

Use this to explore the graph edges between companies and filings.

Use search_filings(ticker=...) for a company's own filings or search_filings( referenced_ticker=...) to find mentions via the filing column. This reads the canonical edge tables keyed on ticker (format like 0700.HK; discover valid values via list_companies(view="tickers")): kind="referenced_by" returns filings whose title mentions the company (cross-references), kind="owned" returns the company's own filings. Results are paged via limit/offset and stay empty until graph linking has been run. This tool is read-only.