@pairsystems/goodmem-mcp 0.1.11 → 0.1.13

package/README.md

@@ -134,7 +134,7 @@ Inspect the built-in model registry. Shows what fields will be auto-inferred for
 | `goodmem_embedders_update` | Update embedder configuration |
 | `goodmem_embedders_delete` | Delete an embedder |
 
-**Create parameters**: `display_name` (required), `model_identifier` (required), `credentials` (required for SaaS providers), `provider_type`, `endpoint_url`, `dimensionality` — last three auto-inferred from `model_identifier` for 29 known models.
+**Create parameters**: `display_name` (required), `model_identifier` (required), `credentials` (required for SaaS providers), `provider_type`, `endpoint_url`, `dimensionality` — last three auto-inferred from `model_identifier` for known models.
 
 ### LLMs
 
@@ -146,7 +146,7 @@ Inspect the built-in model registry. Shows what fields will be auto-inferred for
 | `goodmem_llms_update` | Update LLM configuration |
 | `goodmem_llms_delete` | Delete an LLM |
 
-**Create parameters**: `display_name` (required), `model_identifier` (required), `credentials` (required for SaaS providers) — `provider_type`, `endpoint_url`, `max_context_length` auto-inferred for 34 known models.
+**Create parameters**: `display_name` (required), `model_identifier` (required), `credentials` (required for SaaS providers) — `provider_type`, `endpoint_url`, `max_context_length` auto-inferred for known models.
 
 ### Rerankers
 
@@ -158,7 +158,7 @@ Inspect the built-in model registry. Shows what fields will be auto-inferred for
 | `goodmem_rerankers_update` | Update reranker configuration |
 | `goodmem_rerankers_delete` | Delete a reranker |
 
-**Create parameters**: `display_name` (required), `model_identifier` (required), `credentials` (required for SaaS providers) — `provider_type` and `endpoint_url` auto-inferred for 16 known models.
+**Create parameters**: `display_name` (required), `model_identifier` (required), `credentials` (required for SaaS providers) — `provider_type` and `endpoint_url` auto-inferred for known models.
 
 ### Spaces
 

package/dist/index.js

@@ -21050,7 +21050,14 @@ async function callApiNdjson(method, path, body, query, timeoutSec) {
     throw new Error(`GoodMem API error ${resp.status}: ${text2}`);
   }
   const text = await resp.text();
-  return text.split("\n").map((line) => line.trim()).filter(Boolean).map((line) => JSON.parse(line));
+  const lines = text.split("\n").map((line) => line.trim()).filter(Boolean);
+  return lines.map((line, i) => {
+    try {
+      return JSON.parse(line);
+    } catch (e) {
+      throw new Error(`NDJSON parse error on line ${i + 1}: ${e instanceof Error ? e.message : String(e)}`);
+    }
+  });
 }
 var MODEL_REGISTRY = {
   "embedders": {
@@ -21885,6 +21892,9 @@ function checkCredentialRequired(args) {
     throw new Error(`Provider '${provider}' at '${endpointUrl}' requires credentials. Pass credentials: { kind: "CREDENTIAL_KIND_API_KEY", apiKey: { inlineSecret: "your-key-here" } }`);
   }
 }
+function camelToSnake(s) {
+  return s.replace(/([A-Z]+)([A-Z][a-z]{2,})/g, "$1_$2").replace(/([a-z0-9])([A-Z])/g, "$1_$2").toLowerCase();
+}
 function autoInferFromRegistry(registryType, args) {
   const result = { ...args };
   const modelId = result.model_identifier;
@@ -21892,9 +21902,6 @@ function autoInferFromRegistry(registryType, args) {
     return result;
   const registry2 = MODEL_REGISTRY[registryType] ?? {};
   const entry = registry2[modelId];
-  function camelToSnake(s) {
-    return s.replace(/([A-Z]+)([A-Z][a-z]{2,})/g, "$1_$2").replace(/([a-z0-9])([A-Z])/g, "$1_$2").toLowerCase();
-  }
   if (entry) {
     for (const [key, value] of Object.entries(entry)) {
       const snakeKey = camelToSnake(key);
@@ -21920,7 +21927,7 @@ function autoInferFromRegistry(registryType, args) {
 }
 var server = new McpServer({
   name: "goodmem",
-  version: "0.1.11"
+  version: "0.1.13"
 });
 server.tool("goodmem_configure", "Configure GoodMem server connection. Call this before using other GoodMem tools if GOODMEM_BASE_URL and GOODMEM_API_KEY environment variables are not set. Session credentials override environment variables.", {
   base_url: external_exports.string().describe("GoodMem server URL (e.g., https://your-server.example.com)"),
@@ -21961,11 +21968,23 @@ server.tool("goodmem_lookup_model", "Look up a model in the registry to see its
     const registry2 = MODEL_REGISTRY[registryKey] ?? {};
     const entry = registry2[args.model_identifier];
     if (entry) {
+      const snakeEntry = {};
+      for (const [k, v] of Object.entries(entry)) {
+        if (k === "dimensions") {
+          const dims = v;
+          if (dims?.default !== void 0) {
+            snakeEntry.dimensionality = dims.default;
+          }
+        } else {
+          snakeEntry[camelToSnake(k)] = v;
+        }
+      }
+      const providerType = entry.providerType;
       return { content: [{ type: "text", text: JSON.stringify({
         model_identifier: args.model_identifier,
         type: label,
-        ...entry,
-        endpointUrl: PROVIDER_ENDPOINTS[entry.providerType] ?? void 0
+        ...snakeEntry,
+        endpoint_url: providerType ? PROVIDER_ENDPOINTS[providerType] : void 0
       }, null, 2) }] };
     }
   }
@@ -21975,7 +21994,7 @@ ${allModels.join("\n")}` }] };
 });
 server.tool("goodmem_client_info", "Return the MCP client package version and the goodmem server commit it was built against. No server connection required.", {}, async () => {
   return { content: [{ type: "text", text: JSON.stringify({
-    mcpVersion: "0.1.11",
+    mcpVersion: "0.1.13",
     basedOnGoodmemCommit: BASED_ON_GOODMEM_COMMIT
   }, null, 2) }] };
 });
@@ -22085,7 +22104,7 @@ function registerTools() {
         quotaProjectId: external_exports.string().describe("Optional quota project used for billing").optional()
       }).passthrough().describe("Configuration when kind is CREDENTIAL_KIND_GCP_ADC").optional(),
       labels: external_exports.any().describe('Optional annotations to aid operators (e.g., "owner=vertex")').optional()
-    }).passthrough().describe("Structured credential payload describing how to authenticate with the provider. Required for SaaS providers such as COHERE, JINA, and VOYAGE; optional for local or proxy providers.").optional(),
+    }).passthrough().describe("Structured credential payload describing how to authenticate with the provider. Required for SaaS providers; optional for local or proxy providers.").optional(),
     labels: external_exports.record(external_exports.string(), external_exports.string()).describe("User-defined labels for categorization").optional(),
     version: external_exports.string().describe("Version information").optional(),
     monitoring_endpoint: external_exports.string().describe("Monitoring endpoint URL").optional(),
@@ -22248,7 +22267,7 @@ function registerTools() {
         quotaProjectId: external_exports.string().describe("Optional quota project used for billing").optional()
       }).passthrough().describe("Configuration when kind is CREDENTIAL_KIND_GCP_ADC").optional(),
       labels: external_exports.any().describe('Optional annotations to aid operators (e.g., "owner=vertex")').optional()
-    }).passthrough().describe("Structured credential payload describing how to authenticate with the provider. Omit for deployments that do not require credentials.").optional(),
+    }).passthrough().describe("Structured credential payload describing how to authenticate with the provider. Required for SaaS providers; optional for local or proxy providers.").optional(),
     labels: external_exports.record(external_exports.string(), external_exports.string()).describe("User-defined labels for categorization").optional(),
     version: external_exports.string().describe("Version information").optional(),
     monitoring_endpoint: external_exports.string().describe("Monitoring endpoint URL").optional(),
@@ -22454,7 +22473,7 @@ function registerTools() {
       }).passthrough().describe("Chunking strategy for this memory (if not provided, uses space default)").optional(),
       extractPageImages: external_exports.boolean().describe("Optional hint to extract page images for eligible document types (for example, PDFs)").optional(),
       fileField: external_exports.string().describe("Optional multipart file field name to bind binary content; required when multiple files are uploaded in a batch multipart request.").optional()
-    }).passthrough()).describe("Array of memory creation requests.")
+    }).passthrough()).min(1).describe("Array of memory creation requests.")
   }, async (args) => {
     const body = {};
     if (args.requests !== void 0)
@@ -22493,7 +22512,7 @@ function registerTools() {
     const result = await callApi("POST", `/v1/memories:batchGet`, body);
     return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
   });
-  server.tool("goodmem_memories_create", "Create a new memory", {
+  server.tool("goodmem_memories_create", "Create a memory from text content or base64-encoded content. Content must be provided via exactly one of `original_content` or `original_content_b64`.", {
     memory_id: external_exports.string().describe("Optional client-provided UUID for the memory. If omitted, the server generates one. Returns ALREADY_EXISTS if the ID is already in use.").optional(),
     space_id: external_exports.string().describe("ID of the space where this memory will be stored"),
     original_content: external_exports.string().describe("Original content as plain text (use either this or originalContentB64)").optional(),
@@ -22564,7 +22583,7 @@ function registerTools() {
     const result = await callApi("GET", `/v1/memories/${encodeURIComponent(String(args.id))}`, void 0, query);
     return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
   });
-  server.tool("goodmem_memories_list", "List memories in a space", {
+  server.tool("goodmem_memories_list", "Lists memories within a given space. Results are paginated \u2014 the returned `Page` eagerly fetches the first page. Access `.data` for items and `.next_token` to resume. Use `for mem in page` to auto-paginate all pages, `page_size` to control items per API call, and `max_items` to cap total results.", {
     space_id: external_exports.string().describe("The UUID of the space containing the memories"),
     include_content: external_exports.boolean().describe("Whether to include the original content in the response (defaults to false).").optional(),
     include_processing_history: external_exports.boolean().describe("Whether to include background job processing history in the response (defaults to false).").optional(),
@@ -22620,7 +22639,7 @@ function registerTools() {
     const result = await callApi("GET", `/v1/memories/${encodeURIComponent(String(args.id))}/pages`, void 0, query);
     return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
   });
-  server.tool("goodmem_memories_retrieve", "Advanced semantic memory retrieval with JSON", {
+  server.tool("goodmem_memories_retrieve", "Performs a streaming semantic search across one or more memory spaces and returns matching chunks ranked by relevance as well as LLM-postprocessed results (like summarization, question-answering, etc.).", {
     message: external_exports.string().describe("Primary query/message for semantic search."),
     context: external_exports.array(external_exports.object({
       text: external_exports.string().describe("Text content for this context item.").optional(),
@@ -22647,6 +22666,10 @@ function registerTools() {
       name: external_exports.string().describe("Fully qualified factory class name of the post-processor to apply."),
       config: external_exports.any().describe("Configuration parameters for the post-processor. Fields depend on the selected processor; see the linked documentation for the built-in ChatPostProcessor schema.").optional()
     }).passthrough().describe("Optional post-processor configuration to transform retrieval results.").optional(),
+    logging: external_exports.object({
+      enabled: external_exports.boolean().describe("Opts this request in to durable server-side request logging."),
+      callerAttributes: external_exports.any().describe("Optional flat scalar attributes attached to the persisted log row. Supported value types are string, integer, floating-point, and boolean.").optional()
+    }).passthrough().describe("Optional durable request logging block for POST retrieve requests. Supply logging.enabled=true to opt in, and optionally attach flat scalar logging.callerAttributes for persisted experiment or tracing metadata.").optional(),
     timeout_sec: external_exports.number().int().describe("Maximum seconds to wait for the streaming response (default: 200).").optional()
   }, async (args) => {
     const body = {};
@@ -22666,10 +22689,12 @@ function registerTools() {
       body["hnsw"] = args.hnsw;
     if (args.post_processor !== void 0)
       body["postProcessor"] = args.post_processor;
+    if (args.logging !== void 0)
+      body["logging"] = args.logging;
     const result = await callApiNdjson("POST", `/v1/memories:retrieve`, body, void 0, args.timeout_sec);
     return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
   });
-  server.tool("goodmem_ocr_document", "Run OCR on a document or image", {
+  server.tool("goodmem_ocr_document", "Run OCR on a document or image. Pass base64-encoded document bytes as `content`. Optionally specify `format` (e.g., PDF, PNG) \u2014 if omitted, the server auto-detects.", {
     content: external_exports.string().describe("Base64-encoded document bytes"),
     format: external_exports.enum(["AUTO", "PDF", "TIFF", "PNG", "JPEG", "BMP"]).describe("Input format hint (AUTO, PDF, TIFF, PNG, JPEG, BMP)").optional(),
     include_raw_json: external_exports.boolean().describe("Include raw OCR JSON payload in the response").optional(),
@@ -22717,7 +22742,7 @@ function registerTools() {
         quotaProjectId: external_exports.string().describe("Optional quota project used for billing").optional()
       }).passthrough().describe("Configuration when kind is CREDENTIAL_KIND_GCP_ADC").optional(),
       labels: external_exports.any().describe('Optional annotations to aid operators (e.g., "owner=vertex")').optional()
-    }).passthrough().describe("Structured credential payload describing how to authenticate with the provider. Required for SaaS providers; optional for local deployments.").optional(),
+    }).passthrough().describe("Structured credential payload describing how to authenticate with the provider. Required for SaaS providers; optional for local or proxy providers.").optional(),
     labels: external_exports.record(external_exports.string(), external_exports.string()).describe("User-defined labels for categorization").optional(),
     version: external_exports.string().describe("Version information").optional(),
     monitoring_endpoint: external_exports.string().describe("Monitoring endpoint URL").optional(),
@@ -22847,7 +22872,7 @@ function registerTools() {
     space_embedders: external_exports.array(external_exports.object({
       embedderId: external_exports.string().describe("The UUID for the embedder to associate with the space."),
       defaultRetrievalWeight: external_exports.number().describe("Relative weight for this embedder used by default during retrieval. If omitted, defaults to 1.0; values need not sum to 1 and can be overridden per request.").optional()
-    }).passthrough()).describe("List of embedder configurations to associate with this space. At least one embedder configuration is required. Each specifies an embedder ID and a relative default retrieval weight used when no per-request overrides are provided."),
+    }).passthrough()).min(1).describe("List of embedder configurations to associate with this space. At least one embedder configuration is required. Each specifies an embedder ID and a relative default retrieval weight used when no per-request overrides are provided."),
     public_read: external_exports.boolean().describe("Indicates if the space and its memories can be read by unauthenticated users or users other than the owner. Defaults to false.").optional(),
     owner_id: external_exports.string().describe("Optional owner ID. If not provided, derived from the authentication context. Requires CREATE_SPACE_ANY permission if specified.").optional(),
     default_chunking_config: external_exports.object({
@@ -22899,7 +22924,7 @@ function registerTools() {
     const result = await callApi("GET", `/v1/spaces/${encodeURIComponent(String(args.id))}`, void 0);
     return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
   });
-  server.tool("goodmem_spaces_list", "List spaces", {
+  server.tool("goodmem_spaces_list", "List spaces accessible to the caller, with optional filtering by owner, labels, and name. Results are paginated \u2014 the returned `Page` eagerly fetches the first page. Access `.data` for items and `.next_token` to resume. Use `for space in page` to auto-paginate all pages, `page_size` to control items per API call, and `max_items` to cap total results.", {
     owner_id: external_exports.string().describe("Filter spaces by owner ID. With LIST_SPACE_ANY permission and ownerId omitted, returns all visible spaces. Otherwise returns caller-owned spaces only. Specifying ownerId without LIST_SPACE_ANY returns PERMISSION_DENIED.").optional(),
     name_filter: external_exports.string().describe("Filter spaces by name using glob pattern matching").optional(),
     max_results: external_exports.number().int().describe("Maximum number of results to return in a single page (defaults to 50, clamped to [1, 1000])").optional(),
@@ -22955,7 +22980,7 @@ function registerTools() {
     const result = await callApi("POST", `/v1/system/init`, void 0);
     return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] };
   });
-  server.tool("goodmem_users_get", "Get a user by ID", {
+  server.tool("goodmem_users_get", "Retrieves a user by ID or email address. Exactly one of `id` and `email` must be provided. For getting your own profile, use `client.users.me()`.", {
     id: external_exports.string().describe("The UUID of the user to retrieve").optional(),
     email: external_exports.string().describe("The email address of the user to retrieve").optional()
   }, async (args) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pairsystems/goodmem-mcp",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "GoodMem MCP server \u2014 exposes GoodMem API as MCP tools",
   "type": "module",
   "main": "dist/index.js",