Skip to main content
Glama
simonmak-ascent

mcp-hkex-filing

by simonmak-ascent
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

list_companies

Read-onlyIdempotent

Retrieve companies that have filings, including ticker, name, and filing count, or just ticker codes.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
viewNoWhat to list: "companies" (default) returns ticker + name + filing count; "tickers" returns just the distinct ticker codes.companies
limitNoMaximum rows (1..100 for companies; 1..1000 for tickers).
offsetNoZero-based offset for paging.
tickerNoCase-insensitive substring match, e.g. '0700'; empty lists all.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.4.1
    • addedInput schema / properties / view / enum
      Added value: +[
+  "companies",
+  "tickers"
+]
  2. Changed2 schema fields changedv0.1.9
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum companies to return (1..100)."New value: +"Maximum rows (1..100 for companies; 1..1000 for tickers)."
    • addedInput schema / properties / view
      Added value: +{
+  "default": "companies",
+  "description": "What to list: \"companies\" (default) returns ticker + name + filing count; \"tickers\" returns just the distinct ticker codes.",
+  "title": "View",
+  "type": "string"
+}
  3. Changed1 schema field changedv0.1.5
    • addedInput schema / properties / ticker
      Added value: +{
+  "default": "",
+  "description": "Case-insensitive substring match, e.g. '0700'; empty lists all.",
+  "title": "Ticker",
+  "type": "string"
+}
  4. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, and the closing sentence confirms read-only. Beyond that, the description discloses non-obvious behavior the annotations cannot: default ordering by filing count descending with ticker tie-break, alphabetical sorting in tickers view, and which view is paged. It does not discuss rate limits or the cost of the tickers view, but the behavioral picture is notably richer than the annotations alone.

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

Conciseness4/5

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

Front-loaded with purpose, then view semantics, then the ticker filter, then exclusions and safety — a sensible order with no filler sentences. Slightly dense and the '0700' example duplicates the schema's own example, which is the only real redundancy.

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

Completeness5/5

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

An output schema exists, so return values need not be explained, and the description covers the remaining agent-facing questions: which view to pick, how results are ordered, how paging behaves, and which sibling to use instead. Nothing needed to call this correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning: the view enum's return shape and sort order (count-descending for companies, alphabetical for tickers) and paging scope, plus the case-insensitive substring semantics of ticker with a concrete example. It goes beyond restating the schema even though the ticker example is duplicated from the schema.

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

Purpose5/5

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

States a specific verb and resource ('list companies... that have filings') and immediately distinguishes the two modes of operation (view="companies" vs view="tickers"). It also names the sibling tools it is not, so an agent can separate it from search_filings and get_statistics without opening any schema.

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

Usage Guidelines5/5

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

Explicitly carves out the two wrong-use cases: 'Not for a company's filings (use search_filings) or for aggregate counts (use get_statistics with group_by="company_ticker")'. This is textbook when-to-use/when-not-to-use with named alternatives.

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

Deploy Server

Other Tools