@pipeworx/mcp-kr-equities 0.0.0-stage → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +133 -2
- package/bin/cli.js +61 -0
- package/lib/index.js +333 -0
- package/package.json +31 -4
- package/server.json +18 -0
- package/tools.json +127 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Mojibake Inc.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,134 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @pipeworx/kr-equities
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Korean listed equities: stock-code to issuer and exchange (KOSPI/KOSDAQ) identity, current quotes, daily history, valuation fundamentals, investor-type flows, market indices and market-cap rankings.
|
|
4
|
+
|
|
5
|
+
Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 1856+ live data sources. This is an independent, unofficial integration — not affiliated with, endorsed by, or published by the upstream provider.
|
|
6
|
+
|
|
7
|
+
## Tools
|
|
8
|
+
|
|
9
|
+
- `kr_search_stocks(query, limit?)` — resolve a Korean name, English name or 6-character code to the listed issuer, code and market.
|
|
10
|
+
- `kr_quote(code)` — price, change, range, volume, market cap, 52-week range, PER/PBR/EPS/dividend yield, foreign ownership, market status.
|
|
11
|
+
- `kr_price_history(code, days?)` — daily OHLCV newest first with window performance.
|
|
12
|
+
- `kr_investor_flows(code)` — daily net buying by foreign, institutional and individual investors.
|
|
13
|
+
- `kr_index(index, days?)` — KOSPI, KOSDAQ or KOSPI200 level and history.
|
|
14
|
+
- `kr_top_by_market_cap(market, limit?, page?)` — largest listed companies by market capitalisation.
|
|
15
|
+
|
|
16
|
+
## Auth
|
|
17
|
+
|
|
18
|
+
Keyless.
|
|
19
|
+
|
|
20
|
+
## Data sources
|
|
21
|
+
|
|
22
|
+
- Korea Exchange, KOSPI and KOSDAQ market data (quotes, index levels, listing identity).
|
|
23
|
+
- English-name lookups fall back to Yahoo Finance's listing search, used only to resolve a name to a Korean code.
|
|
24
|
+
|
|
25
|
+
Codes are 6 characters (digits, or digits plus letters for newer listings). Prices are in KRW and reflect the exchange timestamp in `as_of` (KST); `market_status` says whether the session is open. Names are returned in Korean.
|
|
26
|
+
|
|
27
|
+
## Quick Start
|
|
28
|
+
|
|
29
|
+
Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
|
|
30
|
+
|
|
31
|
+
```json
|
|
32
|
+
{
|
|
33
|
+
"mcpServers": {
|
|
34
|
+
"kr-equities": {
|
|
35
|
+
"url": "https://gateway.pipeworx.io/kr-equities/mcp"
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### What this endpoint actually serves
|
|
42
|
+
|
|
43
|
+
`tools/list` at `https://gateway.pipeworx.io/kr-equities/mcp` returns the tools in the table
|
|
44
|
+
above **plus the shared Pipeworx meta-tools** — `ask_pipeworx`,
|
|
45
|
+
`discover_tools`, `search_within`, `remember`/`recall` and the rest of the
|
|
46
|
+
gateway-wide set. So the tool count you see is larger than this table: a
|
|
47
|
+
single-pack endpoint currently lists roughly 30 shared tools alongside the
|
|
48
|
+
pack's own. The connection's `initialize` response states its exact scope, and
|
|
49
|
+
is the authoritative answer for a given day.
|
|
50
|
+
|
|
51
|
+
This is deliberate, not multiplexing by accident. The meta-tools are what let a
|
|
52
|
+
scoped connection answer a question this pack does not cover — via
|
|
53
|
+
`ask_pipeworx`, which routes across the whole catalog — without you adding a
|
|
54
|
+
second MCP server. There is currently no way to mount a pack endpoint without
|
|
55
|
+
them; if the extra schemas cost you more context than the routing is worth,
|
|
56
|
+
connect to the full gateway once rather than to several pack endpoints.
|
|
57
|
+
|
|
58
|
+
Or connect to the full Pipeworx gateway to get every pack's tools listed
|
|
59
|
+
directly, instead of just this one's:
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"mcpServers": {
|
|
64
|
+
"pipeworx": {
|
|
65
|
+
"url": "https://gateway.pipeworx.io/mcp"
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Both URLs reach the same gateway and the same 1856+ data sources. The
|
|
72
|
+
only difference is which pack's tools are listed **directly**; `ask_pipeworx`
|
|
73
|
+
reaches all of them from either one.
|
|
74
|
+
|
|
75
|
+
## No MCP client? Call it over HTTP
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
curl -X POST https://gateway.pipeworx.io/v1/tools/kr_search_stocks \
|
|
79
|
+
-H 'Content-Type: application/json' \
|
|
80
|
+
-d '{"query":"SK hynix"}'
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
No account needed for the first calls. Inspect any tool: `GET https://gateway.pipeworx.io/v1/tools/kr_search_stocks`. Find one: `POST https://gateway.pipeworx.io/v1/tools/search_packs` with `{"query":"..."}`.
|
|
84
|
+
|
|
85
|
+
## Run it from npm
|
|
86
|
+
|
|
87
|
+
`@pipeworx/mcp-kr-equities` is a local stdio bridge to the Pipeworx gateway: your MCP client
|
|
88
|
+
starts it with `npx`, and it forwards every call to the same
|
|
89
|
+
`https://gateway.pipeworx.io/kr-equities/mcp` endpoint shown above. It needs network access;
|
|
90
|
+
there is no offline mode.
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"mcpServers": {
|
|
95
|
+
"kr-equities": {
|
|
96
|
+
"command": "npx",
|
|
97
|
+
"args": ["-y", "@pipeworx/mcp-kr-equities"]
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Without a key it calls anonymously, capped at 50 calls a day. A free account
|
|
104
|
+
raises that to 200 a day: get a key at https://pipeworx.io/signup and add
|
|
105
|
+
`"env": { "PIPEWORX_API_KEY": "<your key>" }` to the server entry.
|
|
106
|
+
The key is sent as a Bearer token, the same way a hosted connection sends it,
|
|
107
|
+
so calls are metered and billed exactly as they are there.
|
|
108
|
+
|
|
109
|
+
It lists **only** this pack's tools by default. Set `PIPEWORX_META_TOOLS=1` to
|
|
110
|
+
also list `ask_pipeworx` and the other gateway-wide tools.
|
|
111
|
+
|
|
112
|
+
Behind an HTTPS proxy: Node's built-in `fetch` does not read `HTTPS_PROXY` by
|
|
113
|
+
default. Newer Node releases honour it when `NODE_USE_ENV_PROXY=1` is set; check
|
|
114
|
+
your Node version's documentation.
|
|
115
|
+
|
|
116
|
+
## Using with ask_pipeworx
|
|
117
|
+
|
|
118
|
+
Instead of calling tools directly, you can ask questions in plain English —
|
|
119
|
+
this works on the pack endpoint above as well as on the full gateway:
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
ask_pipeworx({ question: "your question about Kr Equities data" })
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
The gateway picks the right tool and fills the arguments automatically.
|
|
126
|
+
|
|
127
|
+
## More
|
|
128
|
+
|
|
129
|
+
- [Docs and guides](https://pipeworx.io/docs)
|
|
130
|
+
- [pipeworx.io](https://pipeworx.io)
|
|
131
|
+
|
|
132
|
+
## License
|
|
133
|
+
|
|
134
|
+
MIT
|
package/bin/cli.js
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// Entry point for `npx @pipeworx/mcp-<slug>` in gateway mode (bin/cli.js).
|
|
3
|
+
//
|
|
4
|
+
// A stdio MCP server that relays every message to the Pipeworx gateway's
|
|
5
|
+
// /<slug>/mcp endpoint -- fleet #3759, docs/standalone-via-gateway-plan.md.
|
|
6
|
+
// It carries no pack code and has no local mode. The relay itself lives in
|
|
7
|
+
// ../lib/index.js (copied from scripts/templates/standalone-gateway-lib.js);
|
|
8
|
+
// this file only owns stdin/stdout.
|
|
9
|
+
//
|
|
10
|
+
// Copied VERBATIM into every gateway-mode package by scripts/publish-pack.sh.
|
|
11
|
+
// Edit scripts/templates/standalone-gateway-cli.js in the monorepo, never a
|
|
12
|
+
// per-pack copy. Zero dependencies, Node 18+.
|
|
13
|
+
//
|
|
14
|
+
// stdout carries newline-delimited JSON-RPC and nothing else; every diagnostic
|
|
15
|
+
// goes to stderr, because a single stray line on stdout breaks the host's
|
|
16
|
+
// parser.
|
|
17
|
+
import { createInterface } from 'node:readline';
|
|
18
|
+
import { relay, bridgeConfig } from '../lib/index.js';
|
|
19
|
+
|
|
20
|
+
const cfg = bridgeConfig();
|
|
21
|
+
const warn = (line) => process.stderr.write(`${line}\n`);
|
|
22
|
+
const write = (msg) => { if (msg) process.stdout.write(`${JSON.stringify(msg)}\n`); };
|
|
23
|
+
|
|
24
|
+
const pending = new Set();
|
|
25
|
+
function track(p) {
|
|
26
|
+
pending.add(p);
|
|
27
|
+
p.finally(() => pending.delete(p));
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
async function handleLine(line) {
|
|
31
|
+
const text = line.trim();
|
|
32
|
+
if (!text) return;
|
|
33
|
+
let message;
|
|
34
|
+
try {
|
|
35
|
+
message = JSON.parse(text);
|
|
36
|
+
} catch {
|
|
37
|
+
write({ jsonrpc: '2.0', id: null, error: { code: -32700, message: 'Parse error' } });
|
|
38
|
+
return;
|
|
39
|
+
}
|
|
40
|
+
// A JSON-RPC batch: relay each member, answer with the non-notification replies.
|
|
41
|
+
if (Array.isArray(message)) {
|
|
42
|
+
const replies = (await Promise.all(message.map((m) => relay(m, { cfg, warn })))).filter(Boolean);
|
|
43
|
+
if (replies.length) write(replies);
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
write(await relay(message, { cfg, warn }));
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
// Requests are handled concurrently and answered as they finish: JSON-RPC ids
|
|
50
|
+
// let the host match them, and a slow tool call must not hold up a ping.
|
|
51
|
+
const rl = createInterface({ input: process.stdin, crlfDelay: Infinity });
|
|
52
|
+
rl.on('line', (line) => {
|
|
53
|
+
track(handleLine(line).catch((err) => warn(`pipeworx-standalone: ${err && err.stack ? err.stack : err}`)));
|
|
54
|
+
});
|
|
55
|
+
rl.on('close', async () => {
|
|
56
|
+
// stdin closed: finish what is in flight, then exit.
|
|
57
|
+
while (pending.size) await Promise.allSettled([...pending]);
|
|
58
|
+
// Exit only once stdout has flushed: on a pipe that is not synchronous
|
|
59
|
+
// everywhere, and a bare exit can drop the last reply.
|
|
60
|
+
process.stdout.write('', () => process.exit(0));
|
|
61
|
+
});
|
package/lib/index.js
ADDED
|
@@ -0,0 +1,333 @@
|
|
|
1
|
+
// @pipeworx/mcp-<slug> -- library half of the gateway bridge (lib/index.js).
|
|
2
|
+
//
|
|
3
|
+
// Copied VERBATIM into every gateway-mode pack package by scripts/publish-pack.sh
|
|
4
|
+
// (fleet #3759, docs/standalone-via-gateway-plan.md section 1). There is no
|
|
5
|
+
// per-pack templating: the slug and version are read from this package's own
|
|
6
|
+
// package.json (`pipeworx.slug`, `version`) at load time, so the same bytes
|
|
7
|
+
// ship in every package and the source hash can cover them once. Edit this
|
|
8
|
+
// file in the monorepo (scripts/templates/standalone-gateway-lib.js), never a
|
|
9
|
+
// per-pack copy.
|
|
10
|
+
//
|
|
11
|
+
// What it is: a relay. Every JSON-RPC message goes to
|
|
12
|
+
// ${PIPEWORX_GATEWAY_URL:-https://gateway.pipeworx.io}/<slug>/mcp, the same
|
|
13
|
+
// endpoint a hosted MCP client uses, so tiers, rate limits and credits apply
|
|
14
|
+
// exactly as they do there. There is no local mode: the pack's code is not in
|
|
15
|
+
// this package.
|
|
16
|
+
//
|
|
17
|
+
// Zero dependencies, plain ESM, Node 18+ (global fetch). Nothing here writes
|
|
18
|
+
// to stdout -- bin/cli.js owns stdout and it carries JSON-RPC only.
|
|
19
|
+
//
|
|
20
|
+
// Environment:
|
|
21
|
+
// PIPEWORX_API_KEY sent as `Authorization: Bearer <key>`. Never as
|
|
22
|
+
// X-API-Key: the gateway reads a pwx_ key sent that way
|
|
23
|
+
// as an unvalidated BYO string with no account.
|
|
24
|
+
// PIPEWORX_GATEWAY_URL gateway base URL (no path), default the public gateway.
|
|
25
|
+
// PIPEWORX_META_TOOLS=1 list the gateway-wide tools (ask_pipeworx, ...) too.
|
|
26
|
+
// PIPEWORX_TIMEOUT_MS per-request timeout, default 120000.
|
|
27
|
+
|
|
28
|
+
import { readFileSync } from 'node:fs';
|
|
29
|
+
|
|
30
|
+
const readJson = (rel) => JSON.parse(readFileSync(new URL(rel, import.meta.url), 'utf8'));
|
|
31
|
+
|
|
32
|
+
const PKG = readJson('../package.json');
|
|
33
|
+
export const SLUG = PKG.pipeworx && PKG.pipeworx.slug;
|
|
34
|
+
if (typeof SLUG !== 'string' || !/^[a-z0-9][a-z0-9_-]*$/.test(SLUG)) {
|
|
35
|
+
throw new Error(`${PKG.name}: package.json carries no valid pipeworx.slug -- this package was built wrong`);
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* The pack's slug on the GATEWAY: the /<slug>/mcp route and the `_meta.pack`
|
|
39
|
+
* every listed tool carries. Usually the same as `slug` (the npm/directory
|
|
40
|
+
* name), but 14 packs differ -- `hex-pm` is `hex_pm` on the gateway -- and
|
|
41
|
+
* filtering tools/list on the npm slug would match none of their tools
|
|
42
|
+
* (fleet #3761). publish-pack.sh stamps it from the gateway manifest.
|
|
43
|
+
*/
|
|
44
|
+
export const GATEWAY_SLUG = (PKG.pipeworx && PKG.pipeworx.gatewaySlug) || SLUG;
|
|
45
|
+
if (typeof GATEWAY_SLUG !== 'string' || !/^[a-z0-9][a-z0-9_-]*$/.test(GATEWAY_SLUG)) {
|
|
46
|
+
throw new Error(`${PKG.name}: package.json carries an invalid pipeworx.gatewaySlug -- this package was built wrong`);
|
|
47
|
+
}
|
|
48
|
+
export const PACKAGE_NAME = PKG.name;
|
|
49
|
+
export const VERSION = PKG.version;
|
|
50
|
+
|
|
51
|
+
/** The pack's own tool definitions at publish time (the offline tools/list answer). */
|
|
52
|
+
export const tools = readJson('../tools.json');
|
|
53
|
+
|
|
54
|
+
const DEFAULT_GATEWAY = 'https://gateway.pipeworx.io';
|
|
55
|
+
const DEFAULT_TIMEOUT_MS = 120_000;
|
|
56
|
+
const SIGNUP_URL = 'https://pipeworx.io/signup';
|
|
57
|
+
const VIA = '(via pipeworx-standalone)';
|
|
58
|
+
|
|
59
|
+
/** Resolve the bridge's settings. Exported for the tests and for callTool. */
|
|
60
|
+
export function bridgeConfig(env = process.env, overrides = {}) {
|
|
61
|
+
const base = String(overrides.gatewayUrl || env.PIPEWORX_GATEWAY_URL || DEFAULT_GATEWAY).trim().replace(/\/+$/, '');
|
|
62
|
+
const apiKey = String(overrides.apiKey ?? env.PIPEWORX_API_KEY ?? '').trim();
|
|
63
|
+
const t = Number(overrides.timeoutMs ?? env.PIPEWORX_TIMEOUT_MS);
|
|
64
|
+
return {
|
|
65
|
+
endpoint: `${base}/${GATEWAY_SLUG}/mcp`,
|
|
66
|
+
apiKey,
|
|
67
|
+
timeoutMs: Number.isFinite(t) && t > 0 ? t : DEFAULT_TIMEOUT_MS,
|
|
68
|
+
metaTools: (overrides.metaTools ?? env.PIPEWORX_META_TOOLS) === '1' || overrides.metaTools === true,
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
function requestHeaders(cfg) {
|
|
73
|
+
const h = {
|
|
74
|
+
'Content-Type': 'application/json',
|
|
75
|
+
Accept: 'application/json',
|
|
76
|
+
// Stable per package version: the gateway remembers a client's name by
|
|
77
|
+
// identifier + User-Agent (workers/gateway/src/client-identity.ts).
|
|
78
|
+
'User-Agent': `pipeworx-standalone/${VERSION} (${PACKAGE_NAME})`,
|
|
79
|
+
// Analytics label only (blob11 = 'standalone'). It never changes tier,
|
|
80
|
+
// limits or price -- anyone can send it.
|
|
81
|
+
'X-Pipeworx-Surface': 'standalone',
|
|
82
|
+
};
|
|
83
|
+
if (cfg.apiKey) h.Authorization = `Bearer ${cfg.apiKey}`;
|
|
84
|
+
return h;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/** Parse a gateway body: JSON, or the last JSON `data:` frame of an SSE stream. */
|
|
88
|
+
function parseBody(text, contentType) {
|
|
89
|
+
if (/text\/event-stream/i.test(contentType || '')) {
|
|
90
|
+
let last = null;
|
|
91
|
+
for (const line of text.split(/\r?\n/)) {
|
|
92
|
+
if (!line.startsWith('data:')) continue;
|
|
93
|
+
try { last = JSON.parse(line.slice(5).trim()); } catch { /* keep-alive or partial frame */ }
|
|
94
|
+
}
|
|
95
|
+
return last;
|
|
96
|
+
}
|
|
97
|
+
try { return JSON.parse(text); } catch { return null; }
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* POST one JSON-RPC message. Never throws: the outcome is one of
|
|
102
|
+
* { kind: 'http', status, headers, body, text } the gateway answered
|
|
103
|
+
* { kind: 'network', detail } DNS, TLS, refused, reset
|
|
104
|
+
* { kind: 'timeout' } no answer in cfg.timeoutMs
|
|
105
|
+
*/
|
|
106
|
+
export async function postToGateway(message, cfg) {
|
|
107
|
+
const ac = new AbortController();
|
|
108
|
+
const timer = setTimeout(() => ac.abort(), cfg.timeoutMs);
|
|
109
|
+
try {
|
|
110
|
+
const res = await fetch(cfg.endpoint, {
|
|
111
|
+
method: 'POST',
|
|
112
|
+
headers: requestHeaders(cfg),
|
|
113
|
+
body: JSON.stringify(message),
|
|
114
|
+
signal: ac.signal,
|
|
115
|
+
});
|
|
116
|
+
const text = await res.text();
|
|
117
|
+
return { kind: 'http', status: res.status, headers: res.headers, body: parseBody(text, res.headers.get('content-type')), text };
|
|
118
|
+
} catch (err) {
|
|
119
|
+
if (ac.signal.aborted || (err && (err.name === 'AbortError' || err.name === 'TimeoutError'))) return { kind: 'timeout' };
|
|
120
|
+
const cause = err && err.cause;
|
|
121
|
+
const detail = (cause && (cause.code || cause.message)) || (err && err.message) || String(err);
|
|
122
|
+
return { kind: 'network', detail };
|
|
123
|
+
} finally {
|
|
124
|
+
clearTimeout(timer);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
// ── The key-not-accepted warning (one per process) ──────────────────
|
|
129
|
+
|
|
130
|
+
let warnedKeyIgnored = false;
|
|
131
|
+
const KEY_IGNORED = 'PIPEWORX_API_KEY was not accepted, calling anonymously.';
|
|
132
|
+
|
|
133
|
+
/** True when a key was sent but the gateway still served the call as anonymous. */
|
|
134
|
+
function keyIgnored(out, cfg) {
|
|
135
|
+
return !!cfg.apiKey && out.kind === 'http' && (out.headers.get('x-ratelimit-tier') || '').toLowerCase() === 'anonymous';
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
function noteTier(out, cfg, warn) {
|
|
139
|
+
if (!keyIgnored(out, cfg) || warnedKeyIgnored) return;
|
|
140
|
+
warnedKeyIgnored = true;
|
|
141
|
+
warn(`${PACKAGE_NAME}: ${KEY_IGNORED} Check the key at ${SIGNUP_URL}.`);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
/** Test hook: forget that the warning was printed. */
|
|
145
|
+
export function _resetWarnings() { warnedKeyIgnored = false; }
|
|
146
|
+
|
|
147
|
+
// ── Results the host shows to the model ─────────────────────────────
|
|
148
|
+
|
|
149
|
+
function errorResult(text, detail) {
|
|
150
|
+
const result = { content: [{ type: 'text', text }], isError: true };
|
|
151
|
+
if (detail) result._meta = { pipeworx_standalone: detail };
|
|
152
|
+
return result;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
const rpcResult = (id, result) => ({ jsonrpc: '2.0', id, result });
|
|
156
|
+
const rpcError = (id, code, message) => ({ jsonrpc: '2.0', id, error: { code, message } });
|
|
157
|
+
|
|
158
|
+
function firstLine(text) {
|
|
159
|
+
const line = String(text || '').split(/\r?\n/).map((l) => l.trim()).find(Boolean) || '(empty body)';
|
|
160
|
+
return line.length > 200 ? `${line.slice(0, 200)}...` : line;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
function unreachableText(cfg, out) {
|
|
164
|
+
if (out.kind === 'timeout') {
|
|
165
|
+
return `The Pipeworx gateway at ${cfg.endpoint} did not answer within ${Math.round(cfg.timeoutMs / 1000)}s, so this call timed out. `
|
|
166
|
+
+ `${PACKAGE_NAME} forwards every call to the Pipeworx gateway and has no local mode. Try again; a call that keeps timing out is worth reporting.`;
|
|
167
|
+
}
|
|
168
|
+
return `Could not reach the Pipeworx gateway at ${cfg.endpoint} (${out.detail}). `
|
|
169
|
+
+ `${PACKAGE_NAME} forwards every call to the Pipeworx gateway and has no local mode, so it needs network access.`;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
function isAuthRequired(body) {
|
|
173
|
+
return !!body && (body.error_code === 'authentication_required'
|
|
174
|
+
|| (body.error && body.error.data && body.error.data.reason === 'authentication_required'));
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/** Map a tools/call outcome to the JSON-RPC response the host gets. */
|
|
178
|
+
function toolsCallResponse(id, out, cfg) {
|
|
179
|
+
if (out.kind !== 'http') return rpcResult(id, errorResult(unreachableText(cfg, out), { reason: out.kind }));
|
|
180
|
+
const { status, body } = out;
|
|
181
|
+
|
|
182
|
+
// Anonymous daily cap: the gateway answers 401 with a JSON-RPC error whose
|
|
183
|
+
// message is the offer. Hosts often swallow protocol errors, so hand it over
|
|
184
|
+
// as a tool result the model actually reads.
|
|
185
|
+
if (status === 401 && isAuthRequired(body)) {
|
|
186
|
+
const data = (body.error && body.error.data) || {};
|
|
187
|
+
const parts = [body.error && body.error.message ? body.error.message : 'The anonymous daily allowance is used up.'];
|
|
188
|
+
if (data.resets_at) parts.push(`The anonymous allowance resets at ${data.resets_at}.`);
|
|
189
|
+
parts.push(cfg.apiKey
|
|
190
|
+
? `${KEY_IGNORED} Check the key, or get a free one at ${SIGNUP_URL}.`
|
|
191
|
+
: `To keep going now, set PIPEWORX_API_KEY in this MCP server's environment; a free key is at ${SIGNUP_URL}.`);
|
|
192
|
+
return rpcResult(id, errorResult(parts.join('\n\n'), { status, reason: 'authentication_required', resets_at: data.resets_at ?? null }));
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
// A keyed tier over its cap: today the gateway answers 429 with a RESULT
|
|
196
|
+
// that has no isError, which reads as a success (fleet #3760). Mark it.
|
|
197
|
+
if (status === 429 && body && body.result && typeof body.result === 'object') {
|
|
198
|
+
const result = { ...body.result, isError: true };
|
|
199
|
+
if (cfg.apiKey && keyIgnored(out, cfg)) {
|
|
200
|
+
result.content = [...(Array.isArray(result.content) ? result.content : []), { type: 'text', text: KEY_IGNORED }];
|
|
201
|
+
}
|
|
202
|
+
return rpcResult(id, result);
|
|
203
|
+
}
|
|
204
|
+
if ((status === 401 || status === 429) && body && body.error) {
|
|
205
|
+
const extra = keyIgnored(out, cfg) ? ` ${KEY_IGNORED}` : '';
|
|
206
|
+
return rpcResult(id, errorResult(`${body.error.message || `HTTP ${status}`}${extra}`, { status }));
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
// A real JSON-RPC answer (result or protocol error): relay it verbatim,
|
|
210
|
+
// structuredContent and _meta (cost, tier, provenance) included.
|
|
211
|
+
if (body && body.jsonrpc === '2.0' && (body.result !== undefined || body.error !== undefined) && status < 500) {
|
|
212
|
+
return { ...body, id };
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
// 5xx, an HTML edge page, or anything else that is not JSON-RPC.
|
|
216
|
+
return rpcResult(id, errorResult(`The Pipeworx gateway returned HTTP ${status}: ${firstLine(out.text)}`, { status }));
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function localInitialize(params) {
|
|
220
|
+
return {
|
|
221
|
+
protocolVersion: (params && params.protocolVersion) || '2025-06-18',
|
|
222
|
+
capabilities: { tools: {} },
|
|
223
|
+
serverInfo: { name: PACKAGE_NAME, version: VERSION },
|
|
224
|
+
};
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
const scopedInstructions = () =>
|
|
228
|
+
`${PACKAGE_NAME} forwards to the Pipeworx gateway and lists only the ${SLUG} pack's tools. `
|
|
229
|
+
+ 'Set PIPEWORX_META_TOOLS=1 to also list ask_pipeworx and the other gateway-wide tools.';
|
|
230
|
+
|
|
231
|
+
/** `<host name> (via pipeworx-standalone)`. The slug stays OUT of the name: the
|
|
232
|
+
* gateway's scanner-name check substring-matches words like poll/watch/index. */
|
|
233
|
+
export function bridgedClientName(name) {
|
|
234
|
+
const n = typeof name === 'string' && name.trim() ? name.trim() : 'unknown';
|
|
235
|
+
return n.includes(VIA) ? n : `${n} ${VIA}`;
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* Relay one JSON-RPC message to the gateway and return the response to write
|
|
240
|
+
* back, or null for a notification. Never throws.
|
|
241
|
+
*
|
|
242
|
+
* @param {object} message a parsed JSON-RPC request or notification
|
|
243
|
+
* @param {{cfg?: object, warn?: (line: string) => void}} [opts]
|
|
244
|
+
*/
|
|
245
|
+
export async function relay(message, opts = {}) {
|
|
246
|
+
const cfg = opts.cfg || bridgeConfig();
|
|
247
|
+
const warn = opts.warn || ((line) => process.stderr.write(`${line}\n`));
|
|
248
|
+
if (!message || typeof message !== 'object' || message.jsonrpc !== '2.0' || typeof message.method !== 'string') {
|
|
249
|
+
const id = message && typeof message === 'object' && 'id' in message ? message.id : null;
|
|
250
|
+
return rpcError(id ?? null, -32600, 'Invalid Request');
|
|
251
|
+
}
|
|
252
|
+
const isNotification = !('id' in message) || message.id === undefined;
|
|
253
|
+
const id = message.id;
|
|
254
|
+
|
|
255
|
+
if (isNotification) {
|
|
256
|
+
const out = await postToGateway(message, cfg);
|
|
257
|
+
if (out.kind !== 'http') warn(`${PACKAGE_NAME}: notification ${message.method} not delivered: ${unreachableText(cfg, out)}`);
|
|
258
|
+
return null;
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
if (message.method === 'initialize') {
|
|
262
|
+
const params = { ...(message.params || {}) };
|
|
263
|
+
params.clientInfo = { ...(params.clientInfo || {}), name: bridgedClientName(params.clientInfo && params.clientInfo.name) };
|
|
264
|
+
if (!params.clientInfo.version) params.clientInfo.version = '0';
|
|
265
|
+
const out = await postToGateway({ ...message, params }, cfg);
|
|
266
|
+
noteTier(out, cfg, warn);
|
|
267
|
+
if (out.kind === 'http' && out.body && out.body.result && typeof out.body.result === 'object') {
|
|
268
|
+
const result = { ...out.body.result, serverInfo: { name: PACKAGE_NAME, version: VERSION } };
|
|
269
|
+
if (!cfg.metaTools) result.instructions = scopedInstructions();
|
|
270
|
+
return rpcResult(id, result);
|
|
271
|
+
}
|
|
272
|
+
// The host must still start: answer locally and let the calls report the
|
|
273
|
+
// gateway problem when they happen.
|
|
274
|
+
warn(`${PACKAGE_NAME}: initialize answered locally -- ${out.kind === 'http' ? `gateway HTTP ${out.status}` : unreachableText(cfg, out)}`);
|
|
275
|
+
return rpcResult(id, { ...localInitialize(message.params), instructions: scopedInstructions() });
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
if (message.method === 'tools/list') {
|
|
279
|
+
const out = await postToGateway(message, cfg);
|
|
280
|
+
noteTier(out, cfg, warn);
|
|
281
|
+
const listed = out.kind === 'http' && out.body && out.body.result && Array.isArray(out.body.result.tools)
|
|
282
|
+
? out.body.result : null;
|
|
283
|
+
if (listed) {
|
|
284
|
+
if (cfg.metaTools) return rpcResult(id, listed);
|
|
285
|
+
const own = listed.tools.filter((t) => t && t._meta && (t._meta.pack === GATEWAY_SLUG || t._meta.pack === SLUG));
|
|
286
|
+
if (own.length > 0) return rpcResult(id, { ...listed, tools: own });
|
|
287
|
+
warn(`${PACKAGE_NAME}: the gateway listed no ${SLUG} tools; serving the tool list bundled with this package`);
|
|
288
|
+
} else {
|
|
289
|
+
warn(`${PACKAGE_NAME}: tools/list served from the snapshot bundled with this package -- ${out.kind === 'http' ? `gateway HTTP ${out.status}` : unreachableText(cfg, out)}`);
|
|
290
|
+
}
|
|
291
|
+
return rpcResult(id, { tools });
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
if (message.method === 'tools/call') {
|
|
295
|
+
const out = await postToGateway(message, cfg);
|
|
296
|
+
noteTier(out, cfg, warn);
|
|
297
|
+
return toolsCallResponse(id, out, cfg);
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
// Everything else (ping, resources/*, prompts/*, ...): relay as-is.
|
|
301
|
+
const out = await postToGateway(message, cfg);
|
|
302
|
+
noteTier(out, cfg, warn);
|
|
303
|
+
if (out.kind === 'http' && out.body && out.body.jsonrpc === '2.0') return { ...out.body, id };
|
|
304
|
+
if (message.method === 'ping') return rpcResult(id, {});
|
|
305
|
+
return rpcError(id, -32603, out.kind === 'http'
|
|
306
|
+
? `The Pipeworx gateway returned HTTP ${out.status}: ${firstLine(out.text)}`
|
|
307
|
+
: unreachableText(cfg, out));
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* Call one of this pack's tools through the gateway -- the `{tools, callTool}`
|
|
312
|
+
* shape earlier versions of this package exported. Resolves with the tool's
|
|
313
|
+
* structured result; rejects with the gateway's message on any error.
|
|
314
|
+
*
|
|
315
|
+
* @param {string} name
|
|
316
|
+
* @param {Record<string, unknown>} [args]
|
|
317
|
+
* @param {{apiKey?: string, gatewayUrl?: string, timeoutMs?: number}} [opts]
|
|
318
|
+
* apiKey defaults to process.env.PIPEWORX_API_KEY.
|
|
319
|
+
*/
|
|
320
|
+
export async function callTool(name, args = {}, opts = {}) {
|
|
321
|
+
const cfg = bridgeConfig(process.env, opts);
|
|
322
|
+
const res = await relay({ jsonrpc: '2.0', id: 1, method: 'tools/call', params: { name, arguments: args } }, { cfg });
|
|
323
|
+
if (res.error) throw new Error(res.error.message);
|
|
324
|
+
const result = res.result || {};
|
|
325
|
+
const text = Array.isArray(result.content)
|
|
326
|
+
? result.content.filter((c) => c && c.type === 'text').map((c) => c.text).join('\n')
|
|
327
|
+
: '';
|
|
328
|
+
if (result.isError) throw new Error(text || `${name} failed`);
|
|
329
|
+
if (result.structuredContent !== undefined) return result.structuredContent;
|
|
330
|
+
try { return JSON.parse(text); } catch { return text; }
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
export default { tools, callTool };
|
package/package.json
CHANGED
|
@@ -1,6 +1,33 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pipeworx/mcp-kr-equities",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"description": "Korean equities MCP. Keyless, live per request.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "lib/index.js",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": "./lib/index.js",
|
|
9
|
+
"./tools.json": "./tools.json",
|
|
10
|
+
"./package.json": "./package.json"
|
|
11
|
+
},
|
|
12
|
+
"bin": {
|
|
13
|
+
"mcp-kr-equities": "bin/cli.js"
|
|
14
|
+
},
|
|
15
|
+
"files": ["bin/", "lib/", "tools.json", "server.json"],
|
|
16
|
+
"engines": {
|
|
17
|
+
"node": ">=18"
|
|
18
|
+
},
|
|
19
|
+
"keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "kr-equities"],
|
|
20
|
+
"license": "MIT",
|
|
21
|
+
"repository": {
|
|
22
|
+
"type": "git",
|
|
23
|
+
"url": "git+https://github.com/pipeworx-io/mcp-kr-equities.git"
|
|
24
|
+
},
|
|
25
|
+
"mcpName": "io.github.pipeworx-io/kr-equities",
|
|
26
|
+
"pipeworx": {
|
|
27
|
+
"mode": "gateway",
|
|
28
|
+
"slug": "kr-equities",
|
|
29
|
+
"gatewaySlug": "kr-equities",
|
|
30
|
+
"sourceHash": "v1-3376623f1a406aea68eb3ce5a4e8fa77b9211866388827cb0f5689e4edc9eb21",
|
|
31
|
+
"sourceCommit": "5c89d6abb778d45da5d92002eb251978622bedf9"
|
|
32
|
+
}
|
|
33
|
+
}
|
package/server.json
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
|
|
3
|
+
"name": "io.github.pipeworx-io/kr-equities",
|
|
4
|
+
"title": "Kr Equities",
|
|
5
|
+
"description": "Korean equities MCP. Keyless, live per request.",
|
|
6
|
+
"version": "0.2.0",
|
|
7
|
+
"websiteUrl": "https://pipeworx.io/packs/kr-equities",
|
|
8
|
+
"repository": {
|
|
9
|
+
"url": "https://github.com/pipeworx-io/mcp-kr-equities",
|
|
10
|
+
"source": "github"
|
|
11
|
+
},
|
|
12
|
+
"remotes": [
|
|
13
|
+
{
|
|
14
|
+
"type": "streamable-http",
|
|
15
|
+
"url": "https://gateway.pipeworx.io/kr-equities/mcp"
|
|
16
|
+
}
|
|
17
|
+
]
|
|
18
|
+
}
|
package/tools.json
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"name": "kr_search_stocks",
|
|
4
|
+
"description": "Resolve a Korean company name (Korean or English) or 6-character stock code to its listed issuer, code and market (KOSPI or KOSDAQ). Use this to map a ticker like 005930 to Samsung Electronics (삼성전자) or to find the code for \"SK hynix\". Includes ETFs, flagged via is_etf.",
|
|
5
|
+
"inputSchema": {
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"query": {
|
|
9
|
+
"type": "string",
|
|
10
|
+
"description": "Company name (삼성전자, \"samsung electronics\", hynix) or stock code (005930)"
|
|
11
|
+
},
|
|
12
|
+
"limit": {
|
|
13
|
+
"type": "number",
|
|
14
|
+
"description": "Max results (default 10, max 30)"
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"required": [
|
|
18
|
+
"query"
|
|
19
|
+
]
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"name": "kr_quote",
|
|
24
|
+
"description": "Current or last-close quote for one Korean listed stock by 6-character code: price, change, day range, volume, market cap, 52-week range, PER/PBR/EPS/dividend yield, foreign ownership, and the issuer identity and exchange (KOSPI/KOSDAQ). Returns market_status (OPEN/CLOSE) and the exchange timestamp.",
|
|
25
|
+
"inputSchema": {
|
|
26
|
+
"type": "object",
|
|
27
|
+
"properties": {
|
|
28
|
+
"code": {
|
|
29
|
+
"type": "string",
|
|
30
|
+
"description": "6-character Korean stock code, e.g. 005930 (Samsung Electronics), 000660 (SK hynix)"
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"required": [
|
|
34
|
+
"code"
|
|
35
|
+
]
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "kr_price_history",
|
|
40
|
+
"description": "Daily OHLCV history for one Korean listed stock, newest first, with the performance over the window (first-to-last close change %). Use for \"how has X performed\" questions.",
|
|
41
|
+
"inputSchema": {
|
|
42
|
+
"type": "object",
|
|
43
|
+
"properties": {
|
|
44
|
+
"code": {
|
|
45
|
+
"type": "string",
|
|
46
|
+
"description": "6-character Korean stock code, e.g. 005930"
|
|
47
|
+
},
|
|
48
|
+
"days": {
|
|
49
|
+
"type": "number",
|
|
50
|
+
"description": "Trading days to return (default 20, max 120)"
|
|
51
|
+
}
|
|
52
|
+
},
|
|
53
|
+
"required": [
|
|
54
|
+
"code"
|
|
55
|
+
]
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "kr_investor_flows",
|
|
60
|
+
"description": "Recent daily net buying by investor type (foreign, institutional, individual) in shares for one Korean listed stock, plus the foreign holding ratio, newest first.",
|
|
61
|
+
"inputSchema": {
|
|
62
|
+
"type": "object",
|
|
63
|
+
"properties": {
|
|
64
|
+
"code": {
|
|
65
|
+
"type": "string",
|
|
66
|
+
"description": "6-character Korean stock code, e.g. 005930"
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
"required": [
|
|
70
|
+
"code"
|
|
71
|
+
]
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"name": "kr_index",
|
|
76
|
+
"description": "Level, change and recent daily history of a Korean market index: KOSPI, KOSDAQ or KOSPI200.",
|
|
77
|
+
"inputSchema": {
|
|
78
|
+
"type": "object",
|
|
79
|
+
"properties": {
|
|
80
|
+
"index": {
|
|
81
|
+
"type": "string",
|
|
82
|
+
"description": "KOSPI, KOSDAQ or KOSPI200",
|
|
83
|
+
"enum": [
|
|
84
|
+
"KOSPI",
|
|
85
|
+
"KOSDAQ",
|
|
86
|
+
"KOSPI200"
|
|
87
|
+
]
|
|
88
|
+
},
|
|
89
|
+
"days": {
|
|
90
|
+
"type": "number",
|
|
91
|
+
"description": "Daily history rows to include (default 5, max 60)"
|
|
92
|
+
}
|
|
93
|
+
},
|
|
94
|
+
"required": [
|
|
95
|
+
"index"
|
|
96
|
+
]
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"name": "kr_top_by_market_cap",
|
|
101
|
+
"description": "The largest listed companies on KOSPI or KOSDAQ ranked by market capitalisation, with code, price, daily change and volume. Includes ranking offset for paging.",
|
|
102
|
+
"inputSchema": {
|
|
103
|
+
"type": "object",
|
|
104
|
+
"properties": {
|
|
105
|
+
"market": {
|
|
106
|
+
"type": "string",
|
|
107
|
+
"description": "KOSPI or KOSDAQ",
|
|
108
|
+
"enum": [
|
|
109
|
+
"KOSPI",
|
|
110
|
+
"KOSDAQ"
|
|
111
|
+
]
|
|
112
|
+
},
|
|
113
|
+
"limit": {
|
|
114
|
+
"type": "number",
|
|
115
|
+
"description": "Rows (default 10, max 50)"
|
|
116
|
+
},
|
|
117
|
+
"page": {
|
|
118
|
+
"type": "number",
|
|
119
|
+
"description": "Page of results, 1-based (default 1)"
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
"required": [
|
|
123
|
+
"market"
|
|
124
|
+
]
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
]
|