@pipeworx/mcp-index-constituents 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 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,186 @@
1
- # Temporary Holding Version
1
+ # @pipeworx/index-constituents
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Current constituents, weights and sectors of six major US and developed-markets
4
+ equity indexes, plus a dated history of S&P 500 additions and removals —
5
+ point-in-time index membership built from a live ETF proxy, not a licensed
6
+ index feed.
7
+
8
+ 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.
9
+
10
+ ## Tools
11
+
12
+ - `index_constituents(index, limit?, offset?, sector?)` — current equity
13
+ constituents of one index (`sp500`, `sp400`, `sp600`, `russell1000`,
14
+ `russell2000`, `eafe`): ticker, name, GICS sector, weight, and the fund's
15
+ "as of" date. Sorted by weight descending. Cash/collateral/futures the
16
+ tracking ETF also holds are excluded here (see `ishares_etf_holdings`). Default
17
+ `limit` is 50; pass `limit: 600` (the max) to get the whole index in one
18
+ call — a ~503-row S&P 500 answer is available on request, not by default.
19
+ - `ishares_etf_holdings(ticker, limit?, offset?, asset_class?)` — every reported
20
+ position of one of the six tracking ETFs (`IVV`, `IJH`, `IJR`, `IWB`, `IWM`,
21
+ `EFA`), including cash, collateral and futures, each labeled with its own
22
+ `asset_class` so they are never silently folded in with equities.
23
+ - `constituent_changes(index, from?, to?, limit?)` — dated S&P 500 adds and
24
+ removes (`index` must be `sp500`; the other five indexes have no public,
25
+ dated changes table). `from`/`to` accept a bare year ("2024") or an ISO
26
+ date.
27
+
28
+ ## Auth
29
+
30
+ Keyless. Both upstreams are public, unauthenticated pages.
31
+
32
+ ## Data sources
33
+
34
+ - iShares (BlackRock) — the daily holdings file each fund publishes for its
35
+ own index-tracking ETF (IVV/S&P 500, IJH/S&P MidCap 400, IJR/S&P SmallCap
36
+ 600, IWB/Russell 1000, IWM/Russell 2000, EFA/MSCI EAFE). This is a PROXY for
37
+ official index membership, not the index provider's own data: S&P and
38
+ Russell do not publish their constituent files for free, so the fund's
39
+ actual reported portfolio — which tracks its index closely — is the
40
+ nearest public point-in-time stand-in. Weights are the ETF's own portfolio
41
+ weights, not S&P/Russell's published index weights, and can differ slightly
42
+ (cash drag, sampling, corporate-action timing).
43
+ - Wikipedia — "List of S&P 500 companies" and "Historical components of the
44
+ S&P 500" (the latter is this pack's source for `constituent_changes`: a
45
+ community-maintained, citation-backed table of every S&P-announced S&P 500
46
+ swap since 1963, with its effective date and stated reason).
47
+
48
+ **Reuse note (checked 2026-10-12).** BlackRock's site terms
49
+ (blackrock.com/corporate/compliance/terms-and-conditions) say website content
50
+ is "solely for your personal, non-commercial use" and may not be "distribute[d],
51
+ modif[ied], transmit[ted], reuse[d], repost[ed]... for public or commercial
52
+ purposes... without BlackRock's written permission." This pack does not store,
53
+ mirror or redistribute the holdings file: every call fetches the fund's current
54
+ file live (cached at the edge for a day, the same way a normal browser would
55
+ cache it) and returns the parsed rows for that one call. Per the proxy-vs-mirror
56
+ rule (CLAUDE.md, fleet #1389 — "a live upstream call per request needs no
57
+ explicit grant; only bulk-copying/mirroring does"), that is proxying, not
58
+ redistribution; no dataset is baked into this pack or into Pipeworx's own
59
+ storage. Wikipedia's content is CC BY-SA 4.0, which permits reuse including
60
+ attribution-carrying commercial reuse — `source` on every response names
61
+ Wikipedia and the page.
62
+
63
+ ## Notes
64
+
65
+ - The iShares holdings file's column layout is not identical across funds:
66
+ IJH and IJR add a "Type" column and call the weight field "Market Weight"
67
+ instead of "Weight (%)". This pack reads the header by NAME, not by
68
+ position, so a reordered column does not silently misalign the data.
69
+ - `data_as_of` on every response is the fund's own "Fund Holdings as of" date
70
+ from the file, not the time Pipeworx fetched it — use it to judge freshness.
71
+ - The S&P 500 holdings file carries a handful of non-equity rows (cash,
72
+ collateral, a futures contract used to stay fully invested between
73
+ rebalances) even though the fund is "all-equity" by mandate; these are
74
+ excluded from `index_constituents` and labeled plainly in `ishares_etf_holdings`.
75
+ - `constituent_changes` only covers `sp500` today. The other five indexes
76
+ have no equivalent free, dated, citation-backed changes table — adding one
77
+ would mean a different, likely paid, source.
78
+
79
+ ## Quick Start
80
+
81
+ Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
82
+
83
+ ```json
84
+ {
85
+ "mcpServers": {
86
+ "index-constituents": {
87
+ "url": "https://gateway.pipeworx.io/index-constituents/mcp"
88
+ }
89
+ }
90
+ }
91
+ ```
92
+
93
+ ### What this endpoint actually serves
94
+
95
+ `tools/list` at `https://gateway.pipeworx.io/index-constituents/mcp` returns the tools in the table
96
+ above **plus the shared Pipeworx meta-tools** — `ask_pipeworx`,
97
+ `discover_tools`, `search_within`, `remember`/`recall` and the rest of the
98
+ gateway-wide set. So the tool count you see is larger than this table: a
99
+ single-pack endpoint currently lists roughly 30 shared tools alongside the
100
+ pack's own. The connection's `initialize` response states its exact scope, and
101
+ is the authoritative answer for a given day.
102
+
103
+ This is deliberate, not multiplexing by accident. The meta-tools are what let a
104
+ scoped connection answer a question this pack does not cover — via
105
+ `ask_pipeworx`, which routes across the whole catalog — without you adding a
106
+ second MCP server. There is currently no way to mount a pack endpoint without
107
+ them; if the extra schemas cost you more context than the routing is worth,
108
+ connect to the full gateway once rather than to several pack endpoints.
109
+
110
+ Or connect to the full Pipeworx gateway to get every pack's tools listed
111
+ directly, instead of just this one's:
112
+
113
+ ```json
114
+ {
115
+ "mcpServers": {
116
+ "pipeworx": {
117
+ "url": "https://gateway.pipeworx.io/mcp"
118
+ }
119
+ }
120
+ }
121
+ ```
122
+
123
+ Both URLs reach the same gateway and the same 1856+ data sources. The
124
+ only difference is which pack's tools are listed **directly**; `ask_pipeworx`
125
+ reaches all of them from either one.
126
+
127
+ ## No MCP client? Call it over HTTP
128
+
129
+ ```bash
130
+ curl -X POST https://gateway.pipeworx.io/v1/tools/index_constituents \
131
+ -H 'Content-Type: application/json' \
132
+ -d '{"index":"sp500","limit":600}'
133
+ ```
134
+
135
+ No account needed for the first calls. Inspect any tool: `GET https://gateway.pipeworx.io/v1/tools/index_constituents`. Find one: `POST https://gateway.pipeworx.io/v1/tools/search_packs` with `{"query":"..."}`.
136
+
137
+ ## Run it from npm
138
+
139
+ `@pipeworx/mcp-index-constituents` is a local stdio bridge to the Pipeworx gateway: your MCP client
140
+ starts it with `npx`, and it forwards every call to the same
141
+ `https://gateway.pipeworx.io/index-constituents/mcp` endpoint shown above. It needs network access;
142
+ there is no offline mode.
143
+
144
+ ```json
145
+ {
146
+ "mcpServers": {
147
+ "index-constituents": {
148
+ "command": "npx",
149
+ "args": ["-y", "@pipeworx/mcp-index-constituents"]
150
+ }
151
+ }
152
+ }
153
+ ```
154
+
155
+ Without a key it calls anonymously, capped at 50 calls a day. A free account
156
+ raises that to 200 a day: get a key at https://pipeworx.io/signup and add
157
+ `"env": { "PIPEWORX_API_KEY": "<your key>" }` to the server entry.
158
+ The key is sent as a Bearer token, the same way a hosted connection sends it,
159
+ so calls are metered and billed exactly as they are there.
160
+
161
+ It lists **only** this pack's tools by default. Set `PIPEWORX_META_TOOLS=1` to
162
+ also list `ask_pipeworx` and the other gateway-wide tools.
163
+
164
+ Behind an HTTPS proxy: Node's built-in `fetch` does not read `HTTPS_PROXY` by
165
+ default. Newer Node releases honour it when `NODE_USE_ENV_PROXY=1` is set; check
166
+ your Node version's documentation.
167
+
168
+ ## Using with ask_pipeworx
169
+
170
+ Instead of calling tools directly, you can ask questions in plain English —
171
+ this works on the pack endpoint above as well as on the full gateway:
172
+
173
+ ```
174
+ ask_pipeworx({ question: "your question about Index Constituents data" })
175
+ ```
176
+
177
+ The gateway picks the right tool and fills the arguments automatically.
178
+
179
+ ## More
180
+
181
+ - [Docs and guides](https://pipeworx.io/docs)
182
+ - [pipeworx.io](https://pipeworx.io)
183
+
184
+ ## License
185
+
186
+ 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-index-constituents",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.2.0",
4
+ "description": "Index constituents and holdings, point-in-time.",
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-index-constituents": "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", "index-constituents"],
20
+ "license": "MIT",
21
+ "repository": {
22
+ "type": "git",
23
+ "url": "git+https://github.com/pipeworx-io/mcp-index-constituents.git"
24
+ },
25
+ "mcpName": "io.github.pipeworx-io/index-constituents",
26
+ "pipeworx": {
27
+ "mode": "gateway",
28
+ "slug": "index-constituents",
29
+ "gatewaySlug": "index-constituents",
30
+ "sourceHash": "v1-2afb5477fd6d95659243b8be9c2b7e2f4240efb277f0af5abba8e485094d5cc3",
31
+ "sourceCommit": "4844029e402d6bd2fe735add8abf6d46735f8ed5"
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/index-constituents",
4
+ "title": "Index Constituents",
5
+ "description": "Index constituents and holdings, point-in-time.",
6
+ "version": "0.2.0",
7
+ "websiteUrl": "https://pipeworx.io/packs/index-constituents",
8
+ "repository": {
9
+ "url": "https://github.com/pipeworx-io/mcp-index-constituents",
10
+ "source": "github"
11
+ },
12
+ "remotes": [
13
+ {
14
+ "type": "streamable-http",
15
+ "url": "https://gateway.pipeworx.io/index-constituents/mcp"
16
+ }
17
+ ]
18
+ }
package/tools.json ADDED
@@ -0,0 +1,105 @@
1
+ [
2
+ {
3
+ "name": "index_constituents",
4
+ "description": "Current constituents of a major US or developed-markets equity index — ticker, name, GICS sector, and weight — sourced from the matching iShares index-tracking ETF's daily holdings file (the closest free, point-in-time proxy for official index membership and weights; S&P/Russell do not publish those for free). Answers \"what's in the S&P 500 right now\", \"top holdings of the Russell 2000 by weight\", \"which sectors make up the S&P MidCap 400\". Cash, collateral and futures positions the ETF holds are excluded here — use ishares_etf_holdings for those.",
5
+ "inputSchema": {
6
+ "type": "object",
7
+ "properties": {
8
+ "index": {
9
+ "type": "string",
10
+ "description": "Which index. One of: sp500, sp400, sp600, russell1000, russell2000, eafe.",
11
+ "enum": [
12
+ "sp500",
13
+ "sp400",
14
+ "sp600",
15
+ "russell1000",
16
+ "russell2000",
17
+ "eafe"
18
+ ]
19
+ },
20
+ "limit": {
21
+ "type": "number",
22
+ "description": "Max rows to return, sorted by weight descending (default 50, max 600 — pass the max to get the full index in one call)."
23
+ },
24
+ "offset": {
25
+ "type": "number",
26
+ "description": "Rows to skip, for paging past `limit` (default 0)."
27
+ },
28
+ "sector": {
29
+ "type": "string",
30
+ "description": "Optional GICS sector filter, case-insensitive substring match (e.g. \"Health Care\", \"Energy\")."
31
+ }
32
+ },
33
+ "required": [
34
+ "index"
35
+ ]
36
+ }
37
+ },
38
+ {
39
+ "name": "ishares_etf_holdings",
40
+ "description": "Full reported holdings of one of six iShares index-tracking ETFs (IVV, IJH, IJR, IWB, IWM, EFA) as of the fund's own \"as of\" date — every position including cash, collateral and futures, each labeled with its asset class so they are never silently mixed in with equities. Answers \"what does IVV actually hold today\", \"how much cash does this ETF carry\". For just the equity index membership, use index_constituents instead.",
41
+ "inputSchema": {
42
+ "type": "object",
43
+ "properties": {
44
+ "ticker": {
45
+ "type": "string",
46
+ "description": "One of the supported iShares ETFs: IVV, IJH, IJR, IWB, IWM, EFA.",
47
+ "enum": [
48
+ "IVV",
49
+ "IJH",
50
+ "IJR",
51
+ "IWB",
52
+ "IWM",
53
+ "EFA"
54
+ ]
55
+ },
56
+ "limit": {
57
+ "type": "number",
58
+ "description": "Max rows to return, sorted by market value descending (default 50, max 600)."
59
+ },
60
+ "offset": {
61
+ "type": "number",
62
+ "description": "Rows to skip, for paging past `limit` (default 0)."
63
+ },
64
+ "asset_class": {
65
+ "type": "string",
66
+ "description": "Optional filter, case-insensitive exact match against the fund's own asset-class label (e.g. \"Equity\", \"Cash\", \"Futures\", \"Cash Collateral and Margins\", \"Money Market\")."
67
+ }
68
+ },
69
+ "required": [
70
+ "ticker"
71
+ ]
72
+ }
73
+ },
74
+ {
75
+ "name": "constituent_changes",
76
+ "description": "Dated additions and removals from the S&P 500, sourced from Wikipedia's maintained \"Historical components of the S&P 500\" table (every S&P-announced swap since 1963, each with its effective date, the ticker/company added, the ticker/company removed, and the stated reason). Answers \"what changed in the S&P 500 in 2024\", \"when was X removed from the S&P 500 and what replaced it\". Only sp500 is covered — the iShares-backed indexes above have no equivalent public, dated changes table.",
77
+ "inputSchema": {
78
+ "type": "object",
79
+ "properties": {
80
+ "index": {
81
+ "type": "string",
82
+ "description": "Only \"sp500\" is supported.",
83
+ "enum": [
84
+ "sp500"
85
+ ]
86
+ },
87
+ "from": {
88
+ "type": "string",
89
+ "description": "Earliest effective date to include, as a year (\"2024\") or ISO date (\"2024-01-01\"). Omit for no lower bound."
90
+ },
91
+ "to": {
92
+ "type": "string",
93
+ "description": "Latest effective date to include, as a year (\"2024\") or ISO date (\"2024-12-31\"). Omit for no upper bound."
94
+ },
95
+ "limit": {
96
+ "type": "number",
97
+ "description": "Max rows to return, most recent first (default 50, max 600)."
98
+ }
99
+ },
100
+ "required": [
101
+ "index"
102
+ ]
103
+ }
104
+ }
105
+ ]