Skip to main content
Glama
Sign In

Hkma Hk

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Hkma Dataset

hkma_dataset
Read-onlyIdempotent

Fetch ANY HKMA public dataset by its endpoint path (the part after https://api.hkma.gov.hk/public/). Returns the uniform envelope: data rows are under result.records, total under result.datasize. Use this for any HKMA series not covered by a convenience tool. Verified example paths: "market-data-and-statistics/daily-monetary-statistics/daily-figures-interbank-liquidity" (daily HIBOR/aggregate balance/TWI), "market-data-and-statistics/daily-monetary-statistics/daily-figures-monetary-base" (monetary base components), "market-data-and-statistics/monthly-statistical-bulletin/er-ir/hk-interbank-ir-daily" (HIBOR fixings by tenor), "market-data-and-statistics/monthly-statistical-bulletin/er-ir/er-eeri-daily" (HKD exchange rates vs major currencies), "market-data-and-statistics/monthly-statistical-bulletin/er-ir/hkd-fer-daily" (HKD forward points), "market-data-and-statistics/monthly-statistical-bulletin/er-ir/composite-ir" (composite interest rate, monthly), "market-data-and-statistics/monthly-statistical-bulletin/banking/customer-deposits-by-currency", "coin-cart-schedule" (requires lang). Browse more at apidocs.hkma.gov.hk. Dates YYYY-MM-DD; paginate with offset/pagesize.

Input Schema

NameRequiredDescriptionDefault
toNoEnd of date window, YYYY-MM-DD (or YYYY-MM for monthly series), e.g. "2026-01-31".
fromNoStart of date window, YYYY-MM-DD (or YYYY-MM for monthly series), e.g. "2026-01-01".
langNoLanguage of text fields: "en" (default), "tc", or "sc". Required by some datasets (e.g. coin-cart-schedule).
pathYesEndpoint path after /public/, no leading slash, e.g. "market-data-and-statistics/daily-monetary-statistics/daily-figures-interbank-liquidity".
fieldsNoComma-separated subset of columns to return, e.g. "end_of_date,hibor_overnight".
offsetNoZero-based record offset for pagination.
sortbyNoColumn to sort by, e.g. "end_of_date".
pagesizeNoRecords per page (default ~100). Max varies by dataset.
sortorderNoSort direction: "asc" or "desc".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "path": "market-data-and-statistics/daily-monetary-statistics/daily-figures-interbank-liquidity"
+  },
+  {
+    "from": "2024-01-01",
+    "path": "market-data-and-statistics/monthly-statistical-bulletin/er-ir/hk-interbank-ir-daily",
+    "to": "2024-03-31"
+  }
+]
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, and destructiveHint, establishing safety. The description adds value by describing the response envelope (result.records, result.datasize), date format (YYYY-MM-DD), pagination (offset/pagesize), and lang requirement for some datasets. This goes beyond annotations but stops short of detailing error cases or rate limits.

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 fairly long with many example paths, but it is front-loaded with the main purpose and structured logically. Every sentence adds value, though some examples could be trimmed. It avoids fluff and maintains clarity.

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

Completeness4/5

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

Given 9 parameters and no output schema, the description covers key aspects: usage scenario, response format, date format, pagination, and directs to API docs. It could mention error handling or rate limits, but overall it is sufficiently complete for an AI agent to use effectively.

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 baseline is 3. The description adds meaning by explaining that 'path' is 'the part after https://api.hkma.gov.hk/public/' and provides concrete examples. It also clarifies the return envelope and dataset-specific behaviors (e.g., lang requirement). This extra context justifies a 4.

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 it fetches any HKMA public dataset by endpoint path, and distinguishes itself from sibling convenience tools by specifying 'use this for any HKMA series not covered by a convenience tool.' It uses a specific verb 'fetch' and resource 'HKMA public dataset', making purpose unambiguous and differentiated.

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?

The description explicitly tells when to use this tool ('for any HKMA series not covered by a convenience tool') and provides example paths. It also directs users to browse more at apidocs.hkma.gov.hk, offering clear context and alternatives.

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

All Hkma Hk toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources