@pipeworx/mcp-stooq 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pipeworx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# mcp-stooq
+
+Stooq market-quotes MCP.
+
+Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 697+ live data sources.
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+
+## Quick Start
+
+Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
+
+```json
+{
+  "mcpServers": {
+    "stooq": {
+      "url": "https://gateway.pipeworx.io/stooq/mcp"
+    }
+  }
+}
+```
+
+Or connect to the full Pipeworx gateway for access to all 697+ data sources:
+
+```json
+{
+  "mcpServers": {
+    "pipeworx": {
+      "url": "https://gateway.pipeworx.io/mcp"
+    }
+  }
+}
+```
+
+## Using with ask_pipeworx
+
+Instead of calling tools directly, you can ask questions in plain English:
+
+```
+ask_pipeworx({ question: "your question about Stooq data" })
+```
+
+The gateway picks the right tool and fills the arguments automatically.
+
+## More
+
+- [All tools and guides](https://github.com/pipeworx-io/examples)
+- [pipeworx.io](https://pipeworx.io)
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@pipeworx/mcp-stooq",
+  "version": "0.1.0",
+  "description": "Stooq market-quotes MCP.",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "stooq"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pipeworx-io/mcp-stooq"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0"
+  }
+}

package/server.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
+  "name": "io.github.pipeworx-io/stooq",
+  "title": "Stooq",
+  "description": "Stooq market-quotes MCP.",
+  "version": "0.1.0",
+  "websiteUrl": "https://pipeworx.io/packs/stooq",
+  "repository": {
+    "url": "https://github.com/pipeworx-io/mcp-stooq",
+    "source": "github"
+  },
+  "remotes": [
+    {
+      "type": "streamable-http",
+      "url": "https://gateway.pipeworx.io/stooq/mcp"
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,206 @@
+interface McpToolDefinition {
+  name: string;
+  description: string;
+  inputSchema: {
+    type: 'object';
+    properties: Record<string, unknown>;
+    required?: string[];
+  };
+}
+
+interface McpToolExport {
+  tools: McpToolDefinition[];
+  callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
+  meter?: { credits: number };
+  cost?: Record<string, unknown>;
+  provider?: string;
+}
+
+/**
+ * Stooq market-quotes MCP.
+ *
+ * Keyless. Pulls free, real-time-ish stock, index, forex and commodity quotes from
+ * stooq.com's public CSV endpoint and parses the CSV into clean JSON.
+ *
+ * Stooq is a free community data source — no API key, but also NO SLA: it can be slow,
+ * rate-limit, or briefly return no data. Treat it as best-effort.
+ *
+ * Symbol conventions (use symbol_guide for the full list):
+ *   - US stocks: lowercase ticker + ".us"   e.g. aapl.us, msft.us, brk-b.us
+ *   - Indices:   "^" prefix                  e.g. ^spx (S&P 500), ^dji (Dow), ^ndq (Nasdaq)
+ *   - Forex:     6-letter pair, no separator e.g. eurusd, gbpusd, usdjpy
+ *   - Crypto:    pair vs fiat                e.g. btcusd, ethusd
+ *   - Futures:   root + ".f"                 e.g. gc.f (gold), cl.f (crude oil), si.f (silver)
+ *   - Non-US equities use country suffixes too (e.g. .uk, .de, .jp).
+ *
+ * Implementation notes:
+ *   - Only the latest-quote endpoint (/q/l/) is keyless. Stooq's historical CSV endpoint
+ *     (/q/d/l/) now requires an apikey + captcha, so this pack does not offer history.
+ *   - Multiple symbols MUST be joined with "+" on the wire (comma yields a malformed row);
+ *     callers may pass an array or a comma/space/plus-separated string — we normalize.
+ *   - Unknown/invalid symbols come back as a row of "N/D" values; those are filtered into
+ *     a `notFound` list rather than emitted as bogus quotes.
+ */
+
+
+const BASE = 'https://stooq.com/q/l/';
+const UA = 'pipeworx-mcp-stooq/1.0 (+https://pipeworx.io)';
+
+/** Field spec: Symbol, Date, Time, OHLC, Volume — plus header row (h). */
+const FIELDS = 'sd2t2ohlcv';
+
+const SYMBOL_EXAMPLES = [
+  { kind: 'US stock', example: 'aapl.us', note: 'lowercase ticker + ".us" suffix' },
+  { kind: 'index', example: '^spx', note: '"^" prefix; also ^dji (Dow), ^ndq (Nasdaq Composite)' },
+  { kind: 'forex pair', example: 'eurusd', note: '6-letter pair, no separator; e.g. gbpusd, usdjpy' },
+  { kind: 'crypto', example: 'btcusd', note: 'pair vs fiat; e.g. ethusd' },
+  { kind: 'futures', example: 'gc.f', note: 'root + ".f"; e.g. cl.f (crude), si.f (silver)' },
+  { kind: 'non-US equity', example: 'vod.uk', note: 'country suffix (.uk, .de, .jp, ...)' },
+];
+
+const tools: McpToolExport['tools'] = [
+  {
+    name: 'quote',
+    description:
+      'Latest market quote (OHLCV + date/time) for one or more symbols from Stooq, a free community data ' +
+      'source (no key, no SLA — best-effort, may rate-limit). Parsed from Stooq CSV into clean JSON. ' +
+      'Covers US stocks (aapl.us), indices (^spx, ^dji, ^ndq), forex pairs (eurusd), crypto (btcusd), ' +
+      'and futures (gc.f, cl.f). See symbol_guide for conventions. Unknown symbols are returned in a ' +
+      'separate notFound list. Volume is often empty for forex/futures.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        symbols: {
+          description:
+            'One or more Stooq symbols. Accepts an array ["aapl.us","^spx"] or a comma/space/plus-separated ' +
+            'string ("aapl.us, msft.us"). US stocks use ".us"; indices use "^"; forex like "eurusd"; futures like "gc.f".',
+          oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'string' } }],
+        },
+      },
+      required: ['symbols'],
+    },
+  },
+  {
+    name: 'symbol_guide',
+    description:
+      'Explain Stooq symbol conventions (US ".us", indices "^", forex pairs, crypto, futures ".f") with ' +
+      'worked examples, so you can construct the right symbol before calling quote.',
+    inputSchema: { type: 'object', properties: {} },
+  },
+];
+
+async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
+  switch (name) {
+    case 'symbol_guide':
+      return {
+        source: 'Stooq (stooq.com) — free community market data, keyless, no SLA.',
+        conventions: SYMBOL_EXAMPLES,
+        note: 'Symbols are case-insensitive. Pass multiple symbols to quote at once. ' +
+          'Historical/daily data requires a Stooq apikey and is not available through this pack.',
+      };
+
+    case 'quote': {
+      const symbols = parseSymbols(args.symbols);
+      if (symbols.length === 0) {
+        throw new Error('Required argument "symbols" is missing. Pass e.g. "aapl.us" or ["aapl.us","^spx"].');
+      }
+      // Stooq requires "+" between symbols on the wire; comma yields a malformed single row.
+      const s = symbols.join('+');
+      const url = `${BASE}?s=${encodeURIComponent(s)}&f=${FIELDS}&h&e=csv`;
+      const res = await fetch(url, { headers: { Accept: 'text/csv', 'User-Agent': UA } });
+      const body = await res.text();
+      if (!res.ok) throw new Error(`Stooq: ${res.status} ${body.slice(0, 200)}`);
+      return parseQuotes(body);
+    }
+
+    default:
+      throw new Error(`Unknown tool: ${name}`);
+  }
+}
+
+interface Quote {
+  symbol: string;
+  date: string | null;
+  time: string | null;
+  open: number | null;
+  high: number | null;
+  low: number | null;
+  close: number | null;
+  volume: number | null;
+}
+
+/**
+ * Stooq /q/l/ CSV with f=sd2t2ohlcv&h (verified):
+ *   Symbol,Date,Time,Open,High,Low,Close,Volume
+ *   AAPL.US,2026-06-02,20:59:27,307.46,315.45,306.72,314.69,21713232
+ * Unknown symbols return a row whose fields are all "N/D".
+ * Volume can be empty (forex/futures) — emitted as null.
+ */
+function parseQuotes(csv: string): { quotes: Quote[]; notFound: string[] } {
+  const lines = csv.split(/\r?\n/).filter((l) => l.trim().length > 0);
+  const quotes: Quote[] = [];
+  const notFound: string[] = [];
+  // Drop the header row if present.
+  const start = lines.length > 0 && /^symbol\b/i.test(lines[0]) ? 1 : 0;
+
+  for (let i = start; i < lines.length; i++) {
+    const cells = splitCsvLine(lines[i]);
+    if (cells.length < 2) continue;
+    const symbol = cells[0];
+    // No-data row: Date is "N/D".
+    if ((cells[1] ?? '').toUpperCase() === 'N/D') {
+      notFound.push(symbol);
+      continue;
+    }
+    quotes.push({
+      symbol,
+      date: cell(cells[1]),
+      time: cell(cells[2]),
+      open: num(cells[3]),
+      high: num(cells[4]),
+      low: num(cells[5]),
+      close: num(cells[6]),
+      volume: num(cells[7]),
+    });
+  }
+  return { quotes, notFound };
+}
+
+function splitCsvLine(line: string): string[] {
+  // Stooq quote rows contain no embedded commas/quotes; a simple split is safe.
+  return line.split(',').map((s) => s.trim());
+}
+
+/** Empty or "N/D" -> null; otherwise the trimmed string. */
+function cell(raw: string | undefined): string | null {
+  const v = (raw ?? '').trim();
+  if (v === '' || v.toUpperCase() === 'N/D') return null;
+  return v;
+}
+
+/** Parse a numeric cell; empty / "N/D" / non-numeric -> null. */
+function num(raw: string | undefined): number | null {
+  const v = cell(raw);
+  if (v === null) return null;
+  const n = Number(v);
+  return Number.isFinite(n) ? n : null;
+}
+
+/** Accept an array or a comma/space/plus-separated string of symbols; lowercase, dedupe. */
+function parseSymbols(v: unknown): string[] {
+  let parts: string[];
+  if (Array.isArray(v)) parts = v.map((x) => String(x));
+  else if (typeof v === 'string') parts = v.split(/[\s,+]+/);
+  else return [];
+  const out: string[] = [];
+  const seen = new Set<string>();
+  for (const p of parts) {
+    const s = p.trim().toLowerCase();
+    if (!s || seen.has(s)) continue;
+    seen.add(s);
+    out.push(s);
+  }
+  return out;
+}
+
+export default { tools, callTool, meter: { credits: 1 } } satisfies McpToolExport;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true
+  },
+  "include": ["src"]
+}