Skip to main content
Glama
README.md
# @pipeworx/hk-sfc-alerts

Has the Hong Kong Securities and Futures Commission warned the public about this firm or website? The SFC's Alert List covers entities it says are not licensed to carry on a regulated activity in Hong Kong, suspicious websites, suspicious virtual asset trading platforms, fake regulators and phishing sites (about 3,200 entries since 2000). This is a warning list, not the register of licensed firms.

Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 2007+ live data sources. This is an independent, unofficial integration — not affiliated with, endorsed by, or published by the upstream provider.

## Tools

- `hk_sfc_alert_list_search(query?, type?, date_from?, date_to?, limit?)` -- case-insensitive substring match on the names as the SFC lists them (English and Chinese), optional list type and add-date window, newest first. Each entry gives the id, the name(s), the list type, the date added, whether it is a new listing and the link to the SFC's notice. Also returns `total_matching`, `searched` (rows in the list and the dates covered), `skipped_possible_individuals` and `data_as_of`.
- `hk_sfc_alert_get(id)` -- one entry by id: names, type, the SFC's own remarks, the website it lists and the date added. An unknown id returns `found: false`.

## Auth

Keyless.

## Data sources

- Hong Kong Securities and Futures Commission, Alert List. Read from the publisher on request and held in the serving process for 30 minutes (about 1.2 MB); `data_as_of` is the newest add date.

## Individuals are not returned

Names that read like a natural person (a title such as Mr or Ms, or two to three capitalised words with no company word, or a two or three character Chinese name) are left out and counted in `skipped_possible_individuals`; a row of only such names is not returned. The rule is deliberately conservative, so some firms with person-like trade names are left out too. Addresses on an alert's page are never returned. Every response carries a `note` saying so.

## Behaviour worth knowing

- No match says what was searched (`empty_reason: no_match`) and is not evidence an entity is licensed.
- A page that no longer has the Alert List table, or parses to implausibly few rows, is refused as `upstream_down`, not read as empty.
- The remarks are the SFC's wording at the add date; they are not a finding about the party today.
- The SFC's register of licensed corporations and its enforcement news are not in this pack.

## Quick Start

Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):

```json
{
  "mcpServers": {
    "hk-sfc-alerts": {
      "url": "https://gateway.pipeworx.io/hk-sfc-alerts/mcp"
    }
  }
}
```

### What this endpoint actually serves

`tools/list` at `https://gateway.pipeworx.io/hk-sfc-alerts/mcp` returns the tools in the table
above **plus the shared Pipeworx meta-tools** — `ask_pipeworx`,
`discover_tools`, `search_within`, `remember`/`recall` and the rest of the
gateway-wide set. So the tool count you see is larger than this table: a
single-pack endpoint currently lists roughly 30 shared tools alongside the
pack's own. The connection's `initialize` response states its exact scope, and
is the authoritative answer for a given day.

This is deliberate, not multiplexing by accident. The meta-tools are what let a
scoped connection answer a question this pack does not cover — via
`ask_pipeworx`, which routes across the whole catalog — without you adding a
second MCP server. There is currently no way to mount a pack endpoint without
them; if the extra schemas cost you more context than the routing is worth,
connect to the full gateway once rather than to several pack endpoints.

Or connect to the full Pipeworx gateway to get every pack's tools listed
directly, instead of just this one's:

```json
{
  "mcpServers": {
    "pipeworx": {
      "url": "https://gateway.pipeworx.io/mcp"
    }
  }
}
```

Both URLs reach the same gateway and the same 2007+ data sources. The
only difference is which pack's tools are listed **directly**; `ask_pipeworx`
reaches all of them from either one.

## No MCP client? Call it over HTTP

```bash
curl -X POST https://gateway.pipeworx.io/v1/tools/hk_sfc_alert_list_search \
  -H 'Content-Type: application/json' \
  -d '{"query":"capital","type":"unlicensed","limit":3}'
```

No account needed for the first calls. Inspect any tool: `GET https://gateway.pipeworx.io/v1/tools/hk_sfc_alert_list_search`. Find one: `POST https://gateway.pipeworx.io/v1/tools/search_packs` with `{"query":"..."}`.

## Run it from npm

`@pipeworx/mcp-hk-sfc-alerts` is a local stdio bridge to the Pipeworx gateway: your MCP client
starts it with `npx`, and it forwards every call to the same
`https://gateway.pipeworx.io/hk-sfc-alerts/mcp` endpoint shown above. It needs network access;
there is no offline mode.

```json
{
  "mcpServers": {
    "hk-sfc-alerts": {
      "command": "npx",
      "args": ["-y", "@pipeworx/mcp-hk-sfc-alerts"]
    }
  }
}
```

Without a key it calls anonymously, capped at 50 calls a day. A free account
raises that to 200 a day: get a key at https://pipeworx.io/signup and add
`"env": { "PIPEWORX_API_KEY": "<your key>" }` to the server entry.
The key is sent as a Bearer token, the same way a hosted connection sends it,
so calls are metered and billed exactly as they are there.

It lists **only** this pack's tools by default. Set `PIPEWORX_META_TOOLS=1` to
also list `ask_pipeworx` and the other gateway-wide tools.

Behind an HTTPS proxy: Node's built-in `fetch` does not read `HTTPS_PROXY` by
default. Newer Node releases honour it when `NODE_USE_ENV_PROXY=1` is set; check
your Node version's documentation.

## Using with ask_pipeworx

Instead of calling tools directly, you can ask questions in plain English —
this works on the pack endpoint above as well as on the full gateway:

```
ask_pipeworx({ question: "your question about Hk Sfc Alerts data" })
```

The gateway picks the right tool and fills the arguments automatically.

## More

- [Docs and guides](https://pipeworx.io/docs)
- [pipeworx.io](https://pipeworx.io)

## License

MIT