cfpb-mcp 1.0.1 → 1.0.2

package/README.md

@@ -18,3 +18,22 @@ node dist/index.js
 ```
 
 Data comes from the public CFPB API.
+
+<!-- paywall -->
+## Premium tools
+
+These tools need a license key:
+
+* `complaint_facets`
+* `product_catalogue`
+
+Buy a key at https://mcp-marketplace.io/server/io-github-mrfentmen-cfpb-mcp and set it in your MCP client config:
+
+```json
+"env": { "MCP_LICENSE_KEY": "mcp_live_..." }
+```
+
+The key is checked against MCP Marketplace, cached for 24 hours, and keeps
+working offline once one check has succeeded. Every other tool on this server
+stays free.
+<!-- /paywall -->

package/dist/api.js

@@ -23,3 +23,104 @@ export async function search(args) {
             return `${i + 1}. ${get(s, 'complaint_what_happened')?.slice(0, 120) || get(s, 'product')} | product: ${get(s, 'product')} | company: ${get(s, 'company')} | date: ${get(s, 'date_received')}`;
         }).join('\n');
 }
+// ---- muxA tools:
+const CFPB = 'https://www.consumerfinance.gov/data-research/consumer-complaints/search/api/v1/';
+const FACETS = [
+    'product',
+    'state',
+    'issue',
+    'company',
+    'company_response',
+    'company_public_response',
+    'timely',
+    'submitted_via',
+    'tags',
+];
+function count(value) {
+    return Number(value ?? 0).toLocaleString('en-US');
+}
+function pct(part, whole) {
+    if (!whole)
+        return '0%';
+    const p = (part / whole) * 100;
+    return p >= 10 ? `${p.toFixed(1)}%` : `${p.toFixed(2)}%`;
+}
+async function facetsFor(params) {
+    const query = new URLSearchParams({ ...params, size: '0' });
+    const res = await fetch(`${CFPB}?${query.toString()}`, {
+        headers: { 'User-Agent': UA, Accept: 'application/json' },
+        signal: AbortSignal.timeout(45000),
+    });
+    if (!res.ok) {
+        let detail = '';
+        try {
+            const b = (await res.json());
+            detail = Object.values(b).map((v) => JSON.stringify(v)).join(' ').slice(0, 180);
+        }
+        catch {
+            detail = '';
+        }
+        throw new Error(`CFPB returned ${res.status}${detail ? ` | ${detail}` : ''}`);
+    }
+    const d = (await res.json());
+    return { total: Number(d.hits?.total?.value ?? 0), aggregations: d.aggregations ?? {} };
+}
+function bucketsOf(aggregations, facet) {
+    const node = aggregations[facet];
+    const inner = node?.[facet]?.buckets;
+    if (!Array.isArray(inner))
+        return [];
+    return inner.map((b) => ({ key: String(b.key), n: Number(b.doc_count ?? 0) }));
+}
+export async function complaintFacets(args) {
+    const term = (args.search_term ?? '').trim();
+    const product = (args.product ?? '').trim();
+    if (!term && !product) {
+        throw new Error('Provide search_term (free text such as a company) or product (exact CFPB product name).');
+    }
+    const params = {};
+    if (term)
+        params.search_term = term;
+    if (product)
+        params.product = product;
+    const { total, aggregations } = await facetsFor(params);
+    if (!total)
+        return `No CFPB complaints match ${term ? `"${term}"` : `product "${product}"`}.`;
+    const requested = (args.facet ?? '').trim();
+    if (requested && !FACETS.includes(requested)) {
+        return `Unknown facet "${requested}". Use one of: ${FACETS.join(', ')}.`;
+    }
+    const chosen = requested ? [requested] : ['product', 'state', 'issue'];
+    const limit = Math.max(1, Math.min(Math.round(Number(args.limit ?? 8) || 8), 20));
+    const scope = [term ? `text "${term}"` : '', product ? `product "${product}"` : ''].filter(Boolean).join(' + ');
+    const out = [`CFPB complaints for ${scope}: ${count(total)} total, ${FACETS.filter((f) => aggregations[f]).length} facet(s) available.`];
+    for (const facet of chosen) {
+        const rows = bucketsOf(aggregations, facet).sort((a, b) => b.n - a.n);
+        if (!rows.length) {
+            out.push('', `${facet}: no buckets returned.`);
+            continue;
+        }
+        out.push('', `${facet.replace(/_/g, ' ')} (top ${Math.min(limit, rows.length)} of ${rows.length}):`);
+        for (const r of rows.slice(0, limit))
+            out.push(`  ${r.key} | ${count(r.n)} | ${pct(r.n, total)}`);
+        if (rows.length > limit)
+            out.push(`  plus ${rows.length - limit} more buckets`);
+    }
+    out.push('', 'Buckets come from server side Elasticsearch aggregations and are exact counts over the matching set, not a sample.');
+    return out.join('\n');
+}
+export async function productCatalogue(args) {
+    const { total, aggregations } = await facetsFor({});
+    const rows = bucketsOf(aggregations, 'product').sort((a, b) => b.n - a.n);
+    if (!rows.length)
+        throw new Error('CFPB returned no product aggregation.');
+    const limit = Math.max(1, Math.min(Math.round(Number(args.limit ?? 15) || 15), 30));
+    return [
+        `CFPB complaint corpus: ${count(total)} complaints across ${rows.length} product categories.`,
+        ...rows.slice(0, limit).map((r, i) => `${i + 1}. ${r.key} | ${count(r.n)} | ${pct(r.n, total)}`),
+        rows.length > limit ? `plus ${rows.length - limit} smaller categories` : '',
+        'Counts are live Elasticsearch aggregation totals from the CFPB consumer complaint database.',
+    ]
+        .filter(Boolean)
+        .join('\n');
+}

package/dist/license.js

@@ -0,0 +1,79 @@
+// Premium tools on this server need a license key bought from MCP Marketplace.
+// Buyers put the key in their MCP client config as MCP_LICENSE_KEY. Every tool
+// that is not listed in PREMIUM keeps working without a key.
+const SLUG = "cfpb-mcp";
+// Tools that need a key. Everything else is free.
+const PREMIUM = new Set([
+    "complaint_facets",
+    "product_catalogue",
+]);
+const BUY_URL = `https://mcp-marketplace.io/server/io-github-mrfentmen-${SLUG}`;
+// The license check calls the marketplace's verify endpoint directly instead of
+// using @mcp_marketplace/license. That SDK sends no `apikey` header, so every
+// check it makes is rejected by Supabase before it reaches the function. The
+// publishable key below is public by design - it ships in mcp-marketplace.io's
+// own JavaScript and only ever reaches their licence check.
+const DEFAULT_VERIFY_URL = "https://virupvwhtkpkjsiskckg.supabase.co/functions/v1/verify-key";
+const PUBLISHABLE_KEY = "sb_publishable_BuqlW96Ke8C_zzJG-LQv1Q_YHi_r_4h";
+const OK_CACHE_MS = 60 * 60 * 1000;
+const BAD_CACHE_MS = 60 * 1000;
+const seen = new Map();
+const REASONS = {
+    missing_key: "no key is set",
+    invalid_format: "that key is not a valid MCP Marketplace key",
+    not_found: "that key was not found",
+    revoked: "that key has been revoked",
+    rotated: "that key was rotated, use your new one",
+    expired: "that key has expired, renew it",
+    rate_limited: "there were too many checks just now, try again shortly",
+    network_error: "the license server could not be reached",
+};
+function blocked(tool, reason) {
+    const why = REASONS[reason] ?? `the license server answered "${reason}"`;
+    return `"${tool}" needs a license key, but ${why}. ` +
+        `Set MCP_LICENSE_KEY in your MCP client config. Get a key: ${BUY_URL}`;
+}
+async function verify(key) {
+    const res = await fetch(process.env.MCP_LICENSE_VERIFY_URL || DEFAULT_VERIFY_URL, {
+        method: "POST",
+        headers: {
+            apikey: PUBLISHABLE_KEY,
+            Authorization: `Bearer ${PUBLISHABLE_KEY}`,
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify({ key, slug: SLUG }),
+        // an unusable key answers 400 with a JSON body, so read the body either way
+        signal: AbortSignal.timeout(15000),
+    });
+    const data = (await res.json());
+    if (typeof data?.valid !== "boolean")
+        return { valid: false, reason: "unexpected_response" };
+    return data;
+}
+/**
+ * Returns null when the caller may run the tool, or a short message telling
+ * them how to get a key.
+ *
+ * A good key is remembered for an hour, so a busy session does not hit the
+ * license server on every call and keeps working through a brief outage.
+ */
+export async function premiumRequired(tool) {
+    if (!PREMIUM.has(tool))
+        return null;
+    const key = process.env.MCP_LICENSE_KEY;
+    if (!key)
+        return blocked(tool, "missing_key");
+    const hit = seen.get(key);
+    if (hit && Date.now() - hit.at < (hit.valid ? OK_CACHE_MS : BAD_CACHE_MS)) {
+        return hit.valid ? null : blocked(tool, hit.reason ?? "invalid");
+    }
+    let result;
+    try {
+        result = await verify(key);
+    }
+    catch {
+        result = { valid: false, reason: "network_error" };
+    }
+    seen.set(key, { ...result, at: Date.now() });
+    return result.valid ? null : blocked(tool, result.reason ?? "invalid");
+}

package/dist/server.js

@@ -1,6 +1,7 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
-import { search } from "./api.js";
+import { search, complaintFacets, productCatalogue } from "./api.js";
+import { premiumRequired } from "./license.js";
 const text = (value) => ({ content: [{ type: "text", text: value }] });
 const textError = (t) => ({ content: [{ type: "text", text: t }], isError: true });
 const READ_ONLY = { readOnlyHint: true, openWorldHint: true };
@@ -20,5 +21,41 @@ export function createServer() {
             return textError(error(e));
         }
     });
+    server.registerTool("complaint_facets", {
+        title: "Complaint facets",
+        description: "Server side Elasticsearch facet counts for CFPB consumer complaints, by product, state, issue, company, response, timeliness, channel or tag, with share of the matching set.",
+        inputSchema: z.object({ search_term: z.string().describe("Free text, e.g. a company name.").optional(), product: z.string().describe("Exact CFPB product name, e.g. Mortgage.").optional(), facet: z.string().describe("product, state, issue, company, company_response, company_public_response, timely, submitted_via or tags.").optional(), limit: z.number().describe("Max buckets per facet.").optional() }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        // ---- paywall: complaint_facets ----
+        const paywallMessage = await premiumRequired("complaint_facets");
+        if (paywallMessage)
+            return { content: [{ type: "text", text: paywallMessage }], isError: true };
+        // ---- paywall: end ----
+        try {
+            return text(await complaintFacets(args));
+        }
+        catch (e) {
+            return textError(error(e));
+        }
+    });
+    server.registerTool("product_catalogue", {
+        title: "Product catalogue",
+        description: "Every CFPB complaint product category with its live complaint volume and share of the whole corpus.",
+        inputSchema: z.object({ limit: z.number().describe("Max categories.").optional() }),
+        annotations: READ_ONLY,
+    }, async (args) => {
+        // ---- paywall: product_catalogue ----
+        const paywallMessage = await premiumRequired("product_catalogue");
+        if (paywallMessage)
+            return { content: [{ type: "text", text: paywallMessage }], isError: true };
+        // ---- paywall: end ----
+        try {
+            return text(await productCatalogue(args));
+        }
+        catch (e) {
+            return textError(error(e));
+        }
+    });
     return server;
 }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.1",
+  "version": "1.0.2",
   "type": "module",
   "repository": {
     "type": "git",