Skip to main content
Glama

list_hk_companies

Directory of all HK-listed companies (code, zh/en name, board, isin, listing_date) from the full-market securities master. Optional substring search.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
searchNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior2/5

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

With no annotations, the description must carry the full behavioral burden. It mentions the source and output fields, but does not disclose pagination, return format, or the effect of the limit parameter (default 200), which is especially important given the 'all HK-listed companies' wording.

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?

The description is compact and front-loaded with the core purpose and output fields; each sentence adds information. It is slightly telegraphic but contains no filler.

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

Completeness3/5

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

For a simple two-parameter list tool, the description conveys the domain and fields, and the absence of an output schema is partially mitigated by listing the fields. However, limit behavior, pagination, and differentiation from sibling search/list tools remain unaddressed.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate. It explains 'search' as an optional substring search, but 'limit' is left entirely to the schema's name/default with no context about maximum values or pagination.

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?

The description clearly states a specific resource ('all HK-listed companies'), the source ('full-market securities master'), and the returned fields (code, zh/en name, board, isin, listing_date). The HK scope distinguishes it from generic siblings like list_stocks or search_stocks.

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

Usage Guidelines3/5

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

The purpose and optional substring search imply when to use it (browsing all HK companies or filtering by name), but the description does not explicitly say when to prefer this over siblings such as search_stocks or list_stocks, nor does it state any exclusions.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources