@gavdi/cap-mcp 1.1.1 → 1.1.3

package/README.md

@@ -1,5 +1,5 @@
 # CAP MCP Plugin - AI With Ease
-![NPM Version](https://img.shields.io/npm/v/%40gavdi%2Fcap-mcp) ![NPM License](https://img.shields.io/npm/l/%40gavdi%2Fcap-mcp) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/gavdilabs/cap-mcp-plugin/latest)
+![NPM Version](https://img.shields.io/npm/v/%40gavdi%2Fcap-mcp) ![NPM License](https://img.shields.io/npm/l/%40gavdi%2Fcap-mcp) ![NPM Downloads](https://img.shields.io/npm/dm/%40gavdi%2Fcap-mcp) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/gavdilabs/cap-mcp-plugin/latest)
 
 
 

package/cds-plugin.js

@@ -12,8 +12,8 @@ cds.on("bootstrap", async (app) => {
   await plugin?.onBootstrap(app);
 });
 
-cds.on("loaded", async (model) => {
-  await plugin?.onLoaded(model);
+cds.on("serving", async () => {
+  await plugin?.onLoaded(cds.model);
 });
 
 cds.on("shutdown", async () => {

package/lib/annotations/parser.js

@@ -126,9 +126,12 @@ function constructResourceAnnotation(serviceName, target, annotations, definitio
     if (!(0, utils_1.isValidResourceAnnotation)(annotations))
         return undefined;
     const functionalities = (0, utils_1.determineResourceOptions)(annotations);
+    const foreignKeys = new Map(Object.entries(model.definitions?.[`${serviceName}.${target}`].elements ?? {})
+        .filter(([_, v]) => v["@odata.foreignKey4"] !== undefined)
+        .map(([k, v]) => [k, v["@odata.foreignKey4"]]));
     const { properties, resourceKeys } = (0, utils_1.parseResourceElements)(definition, model);
     const restrictions = (0, utils_1.parseCdsRestrictions)(annotations.restrict, annotations.requires);
-    return new structures_1.McpResourceAnnotation(annotations.name, annotations.description, target, serviceName, functionalities, properties, resourceKeys, annotations.wrap, restrictions);
+    return new structures_1.McpResourceAnnotation(annotations.name, annotations.description, target, serviceName, functionalities, properties, resourceKeys, foreignKeys, annotations.wrap, restrictions);
 }
 /**
  * Constructs a tool annotation from parsed annotation data

package/lib/annotations/structures.js

@@ -82,6 +82,8 @@ class McpResourceAnnotation extends McpAnnotation {
     _resourceKeys;
     /** Optional wrapper configuration to expose this resource as tools */
     _wrap;
+    /** Map of foreign keys property -> associated entity */
+    _foreignKeys;
     /**
      * Creates a new MCP resource annotation
      * @param name - Unique identifier for this resource
@@ -91,14 +93,17 @@ class McpResourceAnnotation extends McpAnnotation {
      * @param functionalities - Set of enabled OData query options (filter, top, skip, etc.)
      * @param properties - Map of entity properties to their CDS types
      * @param resourceKeys - Map of key fields to their types
+     * @param foreignKeys - Map of foreign keys used by entity
+     * @param wrap - Wrap usage
      * @param restrictions - Optional restrictions based on CDS roles
      */
-    constructor(name, description, target, serviceName, functionalities, properties, resourceKeys, wrap, restrictions) {
+    constructor(name, description, target, serviceName, functionalities, properties, resourceKeys, foreignKeys, wrap, restrictions) {
         super(name, description, target, serviceName, restrictions ?? []);
         this._functionalities = functionalities;
         this._properties = properties;
         this._resourceKeys = resourceKeys;
         this._wrap = wrap;
+        this._foreignKeys = foreignKeys;
     }
     /**
      * Gets the set of enabled OData query functionalities
@@ -107,6 +112,13 @@ class McpResourceAnnotation extends McpAnnotation {
     get functionalities() {
         return this._functionalities;
     }
+    /**
+     * Gets the map of foreign keys used withing the resource
+     * @returns Map of foreign keys - property name -> associated entity
+     */
+    get foreignKeys() {
+        return this._foreignKeys;
+    }
     /**
      * Gets the map of entity properties to their CDS types
      * @returns Map of property names to type strings

package/lib/annotations/utils.js

@@ -177,18 +177,10 @@ function parseResourceElements(definition, model) {
             continue;
         }
         const result = parseParam(k, v);
-        if (!v.key)
+        if (!v.key || v.type === "cds.Association")
             continue;
         resourceKeys.set(k, result);
     }
-    // for (const [key, value] of Object.entries(definition.elements || {})) {
-    //   if (!value.type) continue;
-    //   const parsedType = value.type.replace("cds.", "");
-    //   properties.set(key, parsedType);
-    //
-    //   if (!value.key) continue;
-    //   resourceKeys.set(key, parsedType);
-    // }
     return {
         properties,
         resourceKeys,

package/lib/mcp/entity-tools.js

@@ -83,23 +83,6 @@ function buildEnhancedQueryDescription(resAnno) {
         : "";
     return baseDesc + assocHint;
 }
-/**
- * Builds field documentation for schema descriptions
- */
-function buildFieldDocumentation(resAnno) {
-    const docs = [];
-    for (const [propName, cdsType] of resAnno.properties.entries()) {
-        const isAssociation = String(cdsType).toLowerCase().includes("association");
-        if (isAssociation) {
-            docs.push(`${propName}(association: compare by key value)`);
-            docs.push(`${propName}_ID(foreign key for ${propName})`);
-        }
-        else {
-            docs.push(`${propName}(${String(cdsType).toLowerCase()})`);
-        }
-    }
-    return docs.join(", ");
-}
 /**
  * Registers CRUD-like MCP tools for an annotated entity (resource).
  * Modes can be controlled globally via configuration and per-entity via @mcp.wrap.
@@ -158,13 +141,6 @@ function registerQueryTool(resAnno, server, authEnabled) {
     const scalarKeys = Array.from(resAnno.properties.entries())
         .filter(([, cdsType]) => !String(cdsType).toLowerCase().includes("association"))
         .map(([name]) => name);
-    // Add foreign key fields for associations to scalar keys for select/orderby
-    for (const [propName, cdsType] of resAnno.properties.entries()) {
-        const isAssociation = String(cdsType).toLowerCase().includes("association");
-        if (isAssociation) {
-            scalarKeys.push(`${propName}_ID`);
-        }
-    }
     // Build where field enum: use same fields as select (scalar + foreign keys)
     // This ensures consistency - what you can select, you can filter by
     const whereKeys = [...scalarKeys];
@@ -369,16 +345,14 @@ function registerCreateTool(resAnno, server, authEnabled) {
     for (const [propName, cdsType] of resAnno.properties.entries()) {
         const isAssociation = String(cdsType).toLowerCase().includes("association");
         if (isAssociation) {
-            // Prefer foreign key input for associations: <assoc>_ID
-            inputSchema[`${propName}_ID`] = zod_1.z
-                .number()
-                .describe(`Foreign key for association ${propName}`)
-                .optional();
+            // Association keys are supplied directly from model loading as of v1.1.2
             continue;
         }
         inputSchema[propName] = (0, utils_2.determineMcpParameterType)(cdsType, propName, `${resAnno.serviceName}.${resAnno.target}`)
             .optional()
-            .describe(`Field ${propName}`);
+            .describe(resAnno.foreignKeys.has(propName)
+            ? `Foreign key to ${resAnno.foreignKeys.get(propName)} on ${propName}`
+            : `Field ${propName}`);
     }
     const hint = constructHintMessage(resAnno, "create");
     const desc = `Resource description: ${resAnno.description}. Create a new ${resAnno.target}. Provide fields; service applies defaults.${hint}`;
@@ -459,15 +433,14 @@ function registerUpdateTool(resAnno, server, authEnabled) {
             continue;
         const isAssociation = String(cdsType).toLowerCase().includes("association");
         if (isAssociation) {
-            inputSchema[`${propName}_ID`] = zod_1.z
-                .number()
-                .describe(`Foreign key for association ${propName}`)
-                .optional();
+            // Association keys are supplied directly from model loading as of v1.1.2
             continue;
         }
         inputSchema[propName] = (0, utils_2.determineMcpParameterType)(cdsType, propName, `${resAnno.serviceName}.${resAnno.target}`)
             .optional()
-            .describe(`Field ${propName}`);
+            .describe(resAnno.foreignKeys.has(propName)
+            ? `Foreign key to ${resAnno.foreignKeys.get(propName)} on ${propName}`
+            : `Field ${propName}`);
     }
     const keyList = Array.from(resAnno.resourceKeys.keys()).join(", ");
     const hint = constructHintMessage(resAnno, "update");

package/lib/mcp/validation.js

@@ -64,7 +64,7 @@ exports.ODataQueryValidationSchemas = {
         .string()
         .min(1)
         .max(200)
-        .regex(/^[a-zA-Z_][a-zA-Z0-9_\s]+(asc|desc)?(,\s*[a-zA-Z_][a-zA-Z0-9_\s]+(asc|desc)?)*$/i),
+        .regex(/^[a-zA-Z_][a-zA-Z0-9_]*(?:\s+(asc|desc))?(?:\s*,\s*[a-zA-Z_][a-zA-Z0-9_]*(?:\s+(asc|desc))?)*$/i),
     filter: zod_1.z.string().min(1).max(1000),
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gavdi/cap-mcp",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "MCP Pluging for CAP",
   "keywords": [
     "MCP",
@@ -26,6 +26,10 @@
     "test": "NODE_ENV=test jest --silent --testTimeout=30000",
     "test:unit": "NODE_ENV=test jest --silent test/unit --testTimeout=30000",
     "test:integration": "NODE_ENV=test jest --silent test/integration --testTimeout=30000",
+    "test:coverage": "NODE_ENV=test jest --silent --coverage --testTimeout=30000",
+    "test:coverage:unit": "NODE_ENV=test jest --silent --coverage test/unit --testTimeout=30000",
+    "test:coverage:integration": "NODE_ENV=test jest --silent --coverage test/integration --testTimeout=30000",
+    "coverage:report": "NODE_ENV=test jest --silent --coverage --passWithNoTests --testTimeout=30000",
     "build": "tsc",
     "inspect": "npx @modelcontextprotocol/inspector",
     "prepare": "husky",
@@ -41,7 +45,7 @@
     "express": "^4"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.17.3",
+    "@modelcontextprotocol/sdk": "^1.19.1",
     "@sap/xssec": "^4.9.1",
     "helmet": "^8.1.0",
     "zod": "^3.25.67",