Skip to main content
Glama

Browse Filing Facets

list_filing_facets
Read-onlyIdempotent

Browse what filings exist in a date window (at most 31 days) without downloading.

``from_date``/``to_date`` accept YYYY-MM-DD or DD/MM/YYYY. Returns counts of the
categories (headline categories), document types, and stock codes present in the window,
each sorted by frequency and capped at 50 values, plus the distinct counts. Optionally
narrow to one ``stock_code``. Use this to discover valid filter values before calling
search_filings; it fetches the window once and extracts no document text.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
to_dateYesYYYY-MM-DD or DD/MM/YYYY
from_dateYesYYYY-MM-DD or DD/MM/YYYY
stock_codeNoOptional exact HKEx stock code to narrow the facets
max_resultsNoMaximum filings to scan (default 50, cap 200)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYesCounts of the window's categories, document types, and stock codes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare read-only/idempotent/non-destructive, and the description goes well beyond them: the 31-day window cap, that it 'fetches the window once and extracts no document text' (cost behavior), and the exact return shape (counts by category/type/stock code, frequency-sorted, capped at 50, plus distinct counts). This is exactly the extra context annotations cannot carry.

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?

Two tight paragraphs, front-loaded with the core purpose and constraint, then usage. Every sentence carries information: scope, formats, return shape, cap, and sibling routing with no filler.

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?

Despite an output schema existing, the description still summarizes the return shape concisely, and it fills the remaining gaps (31-day limit, no text extraction, fetch-once cost, filter-discovery purpose) so an agent has everything needed to call it correctly.

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 a constraint absent from the schema: the date range is capped at 31 days, and it clarifies that stock_code narrows the facets rather than filtering filings. It does not describe max_results semantics, which the schema already covers adequately.

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 ('Browse what filings exist in a date window') with a scope qualifier ('without downloading'), and explicitly contrasts itself with the search_filings sibling. An agent can distinguish it from search_filings and get_filing 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?

Gives an explicit routing rule: 'Use this to discover valid filter values before calling search_filings.' It names the alternative tool and the condition that selects it, so the when-to-use decision is fully determined.

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.