opf-br-mcp 0.8.0 → 0.9.3

package/README.md

@@ -39,7 +39,9 @@ acesso token-eficiente às regras do Open Finance Brasil.
 - `list_domains()` — descoberta: domínios, filtros, versão da spec de origem e estado do cache
 - `search(domain, query?, filters?, limit?, offset?)` — busca filtrada, retorno compacto
 - `get_item(domain, id)` — registro completo
-- `refresh(domain?)` — força re-extração das fontes
+- `refresh(domain?)` — força re-extração das fontes. Prefira passar `domain`:
+  sem ele o server atualiza o que couber em 45s (o timeout padrão do cliente MCP
+  é 60s) e devolve o restante em `pendentes`, para o agente retomar um a um
 
 Fluxo recomendado para o agente: `list_domains` → `search` → `get_item`.
 
@@ -67,7 +69,12 @@ bem na janela de contexto de um agente, e despejá-la desperdiça tokens. A solu
 é **revelação progressiva** — o agente nunca recebe a spec completa de uma vez,
 apenas o mínimo necessário em cada etapa do funil:
 
-1. **`list_domains`** — catálogo barato: quais domínios e filtros existem.
+1. **`list_domains`** — catálogo barato: quais domínios e filtros existem. Os
+   filtros idênticos a uma família inteira de domínios (os 8 `*-openapi`, os 11
+   de seções do Confluence) saem uma única vez em `filterSets`; cada domínio
+   traz `filterSet` e só lista inline o que é próprio dele (em `*-openapi`,
+   apenas `path`, cujo exemplo varia por API). Os filtros aceitos por um domínio
+   são a união dos dois.
 2. **`search`** — índice **pesquisável e resumido**. Cada resultado traz só os
    campos leves (`id`, `type`, `path`, `method`, `summary`/`name`, `required`,
    `in`); o nó pesado da spec (`detail`) e a lista `refs` são removidos do

package/dist/index.js

@@ -18,14 +18,24 @@ function cacheDir() {
 function cachePath(domainId) {
   return join(cacheDir(), `${domainId}.json`);
 }
+function isCacheEntry(value) {
+  const entry = value;
+  return typeof entry === "object" && entry !== null && typeof entry.extractedAt === "string" && typeof entry.packageVersion === "string" && typeof entry.data === "object" && entry.data !== null && Array.isArray(entry.data.items);
+}
 function readCache(domainId) {
   const path = cachePath(domainId);
   if (!existsSync(path)) return null;
+  let parsed;
   try {
-    return JSON.parse(readFileSync(path, "utf8"));
+    parsed = JSON.parse(readFileSync(path, "utf8"));
   } catch {
     return null;
   }
+  if (!isCacheEntry(parsed)) {
+    console.error(`[opf-br-mcp] cache de ${domainId} tem forma inesperada; ignorando (${path})`);
+    return null;
+  }
+  return parsed;
 }
 function writeCache(domainId, data, packageVersion) {
   const entry = {
@@ -46,7 +56,7 @@ function isFresh(entry, ttlHours, now = /* @__PURE__ */ new Date()) {
 }
 
 // src/core/version.ts
-var PACKAGE_VERSION = "0.8.0";
+var PACKAGE_VERSION = "0.9.3";
 
 // src/core/data.ts
 async function getDomainData(domain, force = false, ctx) {
@@ -66,15 +76,52 @@ async function getDomainData(domain, force = false, ctx) {
   }
 }
 
+// src/core/filter-sets.ts
+var FILTER_SETS = {
+  openapi: [
+    { name: "method", description: "Verbo HTTP exato (ex.: POST)" },
+    { name: "schema", description: "Substring no nome do schema (case-insensitive)" },
+    {
+      name: "response",
+      description: "Substring no nome do components.responses, a chave usada no $ref (ex.: 202Webhook)"
+    },
+    {
+      name: "parameter",
+      description: "Substring no nome do components.parameters, a chave usada no $ref (ex.: xFapiInteractionId)"
+    },
+    {
+      name: "header",
+      description: "Substring no nome do components.headers, a chave usada no $ref (ex.: X-V)"
+    }
+  ],
+  sections: [
+    { name: "page", description: "Substring no t\xEDtulo da p\xE1gina Confluence" },
+    { name: "heading", description: "Substring no t\xEDtulo da se\xE7\xE3o (heading)" },
+    { name: "contains", description: "Substring no conte\xFAdo da se\xE7\xE3o" }
+  ]
+};
+
 // src/core/http.ts
-function sleep(ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms));
+function sleep(ms, signal) {
+  if (signal?.aborted) return Promise.resolve();
+  return new Promise((resolve) => {
+    const done = () => {
+      clearTimeout(timer);
+      signal?.removeEventListener("abort", done);
+      resolve();
+    };
+    const timer = setTimeout(done, ms);
+    signal?.addEventListener("abort", done, { once: true });
+  });
 }
 async function fetchWithRetry(url, opts) {
   let lastError;
   for (let attempt = 0; attempt <= opts.retryDelaysMs.length; attempt++) {
     if (opts.signal?.aborted) break;
-    if (attempt > 0) await sleep(opts.retryDelaysMs[attempt - 1]);
+    if (attempt > 0) {
+      await sleep(opts.retryDelaysMs[attempt - 1], opts.signal);
+      if (opts.signal?.aborted) break;
+    }
     const timeout = AbortSignal.timeout(3e4);
     const signal = opts.signal ? AbortSignal.any([opts.signal, timeout]) : timeout;
     let response;
@@ -134,8 +181,14 @@ async function fetchConfluencePage(baseUrl, pageId, retryDelaysMs, signal) {
   const apiUrl = `${baseUrl}/wiki/rest/api/content/${pageId}?expand=body.view`;
   const response = await fetchWithRetry(apiUrl, { retryDelaysMs, headers: HEADERS, signal });
   const json = await response.json();
+  const html = json?.body?.view?.value;
+  if (typeof html !== "string") {
+    throw new Error(
+      `resposta da p\xE1gina ${pageId} n\xE3o traz body.view.value; n\xE3o \xE9 conte\xFAdo Confluence expandido`
+    );
+  }
   return {
-    html: json.body?.view?.value ?? "",
+    html,
     title: json.title,
     url: `${baseUrl}/wiki${json._links?.webui ?? ""}`
   };
@@ -310,8 +363,8 @@ var pcmDomain = {
     const total = pcmConfig.pages.length;
     const pages = [];
     for (const [i, page] of pcmConfig.pages.entries()) {
+      if (i > 0) await sleep(pcmConfig.interRequestDelayMs, ctx?.signal);
       if (ctx?.signal?.aborted) throw new Error("Extra\xE7\xE3o cancelada pelo cliente");
-      if (i > 0) await sleep(pcmConfig.interRequestDelayMs);
       ctx?.onProgress?.(i, total, `Extraindo "${page.title}"`);
       const { html, url } = await fetchConfluencePage(
         pcmConfig.confluenceBaseUrl,
@@ -380,7 +433,13 @@ function refsOf(node, specName) {
   return [...out];
 }
 function parseOpenApiSpec(yamlText, specName) {
-  const spec = parse(yamlText);
+  const parsed = parse(yamlText);
+  if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed) || !("paths" in parsed) && !("components" in parsed)) {
+    throw new Error(
+      `resposta de ${specName} n\xE3o \xE9 uma spec OpenAPI (sem "paths" nem "components"); in\xEDcio do conte\xFAdo: ${JSON.stringify(yamlText.slice(0, 80))}`
+    );
+  }
+  const spec = parsed;
   const items = [];
   for (const [path, pathItem] of Object.entries(spec.paths ?? {})) {
     for (const method of HTTP_METHODS) {
@@ -435,22 +494,10 @@ function createOpenApiDomain(config) {
     description: config.description,
     specVersion: config.specVersion,
     ttlHours: 72,
+    filterSet: "openapi",
     filters: [
       { name: "path", description: `Substring no path do endpoint (ex.: ${config.pathExample})` },
-      { name: "method", description: "Verbo HTTP exato (ex.: POST)" },
-      { name: "schema", description: "Substring no nome do schema (case-insensitive)" },
-      {
-        name: "response",
-        description: "Substring no nome do components.responses, a chave usada no $ref (ex.: 202Webhook)"
-      },
-      {
-        name: "parameter",
-        description: "Substring no nome do components.parameters, a chave usada no $ref (ex.: xFapiInteractionId)"
-      },
-      {
-        name: "header",
-        description: "Substring no nome do components.headers, a chave usada no $ref (ex.: X-V)"
-      }
+      ...FILTER_SETS.openapi
     ],
     async extract(ctx) {
       if (ctx?.signal?.aborted) throw new Error("Extra\xE7\xE3o cancelada pelo cliente");
@@ -592,17 +639,14 @@ function createConfluenceSectionsDomain(config) {
     description: config.description,
     specVersion: config.specVersion,
     ttlHours: 72,
-    filters: [
-      { name: "page", description: "Substring no t\xEDtulo da p\xE1gina Confluence" },
-      { name: "heading", description: "Substring no t\xEDtulo da se\xE7\xE3o (heading)" },
-      { name: "contains", description: "Substring no conte\xFAdo da se\xE7\xE3o" }
-    ],
+    filterSet: "sections",
+    filters: [...FILTER_SETS.sections],
     async extract(ctx) {
       const total = config.pages.length;
       const pages = [];
       for (const [i, page] of config.pages.entries()) {
+        if (i > 0) await sleep(config.interRequestDelayMs, ctx?.signal);
         if (ctx?.signal?.aborted) throw new Error("Extra\xE7\xE3o cancelada pelo cliente");
-        if (i > 0) await sleep(config.interRequestDelayMs);
         ctx?.onProgress?.(i, total, `Extraindo "${page.title}"`);
         const { html, url } = await fetchConfluencePage(
           config.confluenceBaseUrl,
@@ -1000,6 +1044,11 @@ var participantesConfig = {
 // src/domains/participantes/parser.ts
 function parseParticipants(jsonText) {
   const orgs = JSON.parse(jsonText);
+  if (!Array.isArray(orgs) || orgs.length === 0) {
+    throw new Error(
+      `resposta do diret\xF3rio n\xE3o \xE9 uma lista de organiza\xE7\xF5es n\xE3o-vazia; in\xEDcio do conte\xFAdo: ${JSON.stringify(jsonText.slice(0, 80))}`
+    );
+  }
   return orgs.map((org) => {
     const servers = org.AuthorisationServers ?? [];
     const families = /* @__PURE__ */ new Set();
@@ -1181,6 +1230,7 @@ function findDomain(id) {
   return domains.find((d) => d.id === id);
 }
 var validIds = () => domains.map((d) => d.id).join(", ");
+var REFRESH_BUDGET_MS = 45e3;
 var domainIdSchema = z.enum(domains.map((d) => d.id)).describe("Id do dom\xEDnio (ver list_domains)");
 function extractContext(extra) {
   const progressToken = extra._meta?.progressToken;
@@ -1195,7 +1245,7 @@ function extractContext(extra) {
     }
   };
 }
-function createServer() {
+function createServer(refreshBudgetMs = REFRESH_BUDGET_MS) {
   const server2 = new McpServer(
     { name: "opf-br-mcp", version: PACKAGE_VERSION },
     {
@@ -1206,7 +1256,7 @@ function createServer() {
     "list_domains",
     {
       title: "Listar dom\xEDnios",
-      description: "Lista os dom\xEDnios de conhecimento do Open Finance Brasil dispon\xEDveis neste server, com os filtros aceitos por cada um, a vers\xE3o da spec de origem e o estado do cache local. Devolve tamb\xE9m a vers\xE3o deste server em `server.version`. Comece por aqui; depois use search(domain, ...) e get_item(domain, id).",
+      description: "Lista os dom\xEDnios de conhecimento do Open Finance Brasil dispon\xEDveis neste server, com os filtros aceitos por cada um, a vers\xE3o da spec de origem e o estado do cache local. Devolve tamb\xE9m a vers\xE3o deste server em `server.version`. Os filtros aceitos por um dom\xEDnio s\xE3o a uni\xE3o de `filters` (os pr\xF3prios dele, pode vir ausente) com `filterSets[<filterSet>]` (o conjunto comum \xE0 fam\xEDlia, listado uma vez no topo). Comece por aqui; depois use search(domain, ...) e get_item(domain, id).",
       annotations: {
         readOnlyHint: true,
         destructiveHint: false,
@@ -1216,11 +1266,14 @@ function createServer() {
     },
     async () => {
       const out = domains.map((d) => {
+        const shared = d.filterSet ? FILTER_SETS[d.filterSet] : void 0;
+        const own = shared ? d.filters.filter((f) => !shared.some((s) => s.name === f.name && s.description === f.description)) : d.filters;
         const base = {
           id: d.id,
           title: d.title,
           description: d.description,
-          filters: d.filters,
+          ...d.filterSet ? { filterSet: d.filterSet } : {},
+          ...own.length > 0 ? { filters: own } : {},
           ...d.specVersion ? { specVersion: d.specVersion } : {}
         };
         if (d.live) {
@@ -1233,7 +1286,14 @@ function createServer() {
           extractedAt: cached?.extractedAt ?? null
         };
       });
-      return text({ server: { name: "opf-br-mcp", version: PACKAGE_VERSION }, domains: out });
+      const usedSets = Object.fromEntries(
+        Object.entries(FILTER_SETS).filter(([name]) => domains.some((d) => d.filterSet === name))
+      );
+      return text({
+        server: { name: "opf-br-mcp", version: PACKAGE_VERSION },
+        filterSets: usedSets,
+        domains: out
+      });
     }
   );
   server2.registerTool(
@@ -1349,7 +1409,7 @@ function createServer() {
     "refresh",
     {
       title: "Re-extrair fontes",
-      description: "For\xE7a re-extra\xE7\xE3o das fontes p\xFAblicas (ignora o TTL de 72h do cache). Sem `domain`, atualiza todos. Use quando suspeitar de dados desatualizados.",
+      description: "For\xE7a re-extra\xE7\xE3o das fontes p\xFAblicas (ignora o TTL de 72h do cache). Use quando suspeitar de dados desatualizados. Prefira passar `domain`: sem ele o server atualiza o que couber em 45s e devolve o restante em `pendentes`, que voc\xEA deve refazer chamando refresh(domain) para cada id.",
       inputSchema: {
         domain: domainIdSchema.optional().describe("Id do dom\xEDnio; omita para todos")
       },
@@ -1365,7 +1425,13 @@ function createServer() {
         (d) => !d.live && (!domain || d.id === domain)
       );
       const report = {};
+      const pendentes = [];
+      const inicio = Date.now();
       for (const d of targets) {
+        if (!domain && Date.now() - inicio > refreshBudgetMs) {
+          pendentes.push(d.id);
+          continue;
+        }
         try {
           const { data } = await getDomainData(d, true, extractContext(extra));
           report[d.id] = `ok: ${data.items.length} itens`;
@@ -1373,7 +1439,13 @@ function createServer() {
           report[d.id] = `erro: ${err.message}`;
         }
       }
-      return text(report);
+      return text({
+        atualizados: report,
+        ...pendentes.length > 0 ? {
+          pendentes,
+          nota: `Parei em ${refreshBudgetMs / 1e3}s para n\xE3o estourar o timeout do cliente. Chame refresh(domain) para cada id em pendentes.`
+        } : {}
+      });
     }
   );
   return server2;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opf-br-mcp",
-  "version": "0.8.0",
+  "version": "0.9.3",
   "description": "MCP server local com as regras do Open Finance Brasil (PCM additionalInfo, specs OpenAPI de Pagamentos)",
   "type": "module",
   "license": "MIT",