@gavdi/cap-mcp 0.9.4 → 0.9.8

package/lib/mcp/resources.js

@@ -6,9 +6,24 @@ const logger_1 = require("../logger");
 const utils_1 = require("./utils");
 const validation_1 = require("./validation");
 const utils_2 = require("../auth/utils");
-// import cds from "@sap/cds";
 /* @ts-ignore */
 const cds = global.cds || require("@sap/cds"); // This is a work around for missing cds context
+async function resolveServiceInstance(serviceName) {
+    const CDS = global.cds || cds;
+    let svc = CDS.services?.[serviceName] || CDS.services?.[serviceName.toLowerCase()];
+    if (svc)
+        return svc;
+    const providers = (CDS.service && CDS.service.providers) ||
+        (CDS.services && CDS.services.providers) ||
+        [];
+    if (Array.isArray(providers)) {
+        const found = providers.find((p) => p?.definition?.name === serviceName || p?.name === serviceName);
+        if (found)
+            return found;
+    }
+    // do not connect; rely on served providers only to avoid duplicate cds contexts
+    return undefined;
+}
 /**
  * Registers a CAP entity as an MCP resource with optional OData query support
  * Creates either static or dynamic resources based on configured functionalities
@@ -34,7 +49,7 @@ function assignResourceToServer(model, server, authEnabled) {
     server.registerResource(model.name, template, // Type assertion to bypass strict type checking - necessary due to broken URI parser in the MCP SDK
     { title: model.target, description: detailedDescription }, async (uri, variables) => {
         const queryParameters = variables;
-        const service = cds.services[model.serviceName];
+        const service = await resolveServiceInstance(model.serviceName);
         if (!service) {
             logger_1.LOGGER.error(`Invalid service found for service '${model.serviceName}'`);
             throw new Error(`Invalid service found for service '${model.serviceName}'`);
@@ -56,7 +71,7 @@ function assignResourceToServer(model, server, authEnabled) {
                     case "filter":
                         // BUG: If filter value is e.g. "filter=1234" the value 1234 will go through
                         const validatedFilter = validator.validateFilter(v);
-                        const expression = cds.parse.expr(validatedFilter);
+                        const expression = (global.cds || cds).parse.expr(validatedFilter);
                         query.where(expression);
                         continue;
                     case "select":

package/lib/mcp/session-manager.js

@@ -63,18 +63,29 @@ class McpSessionManager {
      * @returns Configured StreamableHTTPServerTransport instance
      */
     createTransport(server) {
+        // Prefer JSON responses to avoid SSE client compatibility issues in dev/mock
+        const enableJson = (0, env_sanitizer_1.getSafeEnvVar)("MCP_ENABLE_JSON", "true") === "true" ||
+            (0, env_sanitizer_1.isTestEnvironment)();
         const transport = new streamableHttp_js_1.StreamableHTTPServerTransport({
             sessionIdGenerator: () => (0, crypto_1.randomUUID)(),
-            enableJsonResponse: (0, env_sanitizer_1.isTestEnvironment)(),
+            enableJsonResponse: enableJson,
             onsessioninitialized: (sid) => {
                 logger_1.LOGGER.debug("Session initialized with ID: ", sid);
+                logger_1.LOGGER.debug("Transport mode", { enableJsonResponse: enableJson });
                 this.sessions.set(sid, {
                     server: server,
                     transport: transport,
                 });
             },
         });
-        transport.onclose = () => this.onCloseSession(transport);
+        // In JSON response mode, HTTP connections are short-lived per request.
+        // Closing the underlying connection does NOT mean the MCP session is over.
+        // Avoid deleting the session on close when enableJson is true.
+        transport.onclose = () => {
+            if (!enableJson) {
+                this.onCloseSession(transport);
+            }
+        };
         return transport;
     }
     /**

package/lib/mcp/tools.js

@@ -43,7 +43,10 @@ function assignBoundOperation(params, model, server, authEnabled) {
         description: model.description,
         inputSchema: inputSchema,
     }, async (args) => {
-        const service = cds.services[model.serviceName];
+        // Resolve from current CAP context; prefer global to align with Jest mocks
+        const cdsMod = global.cds || cds;
+        const servicesMap = cdsMod.services || (cdsMod.services = {});
+        const service = servicesMap[model.serviceName];
         if (!service) {
             logger_1.LOGGER.error("Invalid CAP service - undefined");
             return {
@@ -73,14 +76,7 @@ function assignBoundOperation(params, model, server, authEnabled) {
             data: operationInput,
             params: [operationKeys],
         });
-        return {
-            content: Array.isArray(response)
-                ? response.map((el) => ({
-                    type: "text",
-                    text: formatResponseValue(el),
-                }))
-                : [{ type: "text", text: formatResponseValue(response) }],
-        };
+        return (0, utils_1.asMcpResult)(response);
     });
 }
 /**
@@ -97,7 +93,10 @@ function assignUnboundOperation(params, model, server, authEnabled) {
         description: model.description,
         inputSchema: inputSchema,
     }, async (args) => {
-        const service = cds.services[model.serviceName];
+        // Resolve from current CAP context; prefer global to align with Jest mocks
+        const cdsMod = global.cds || cds;
+        const servicesMap = cdsMod.services || (cdsMod.services = {});
+        const service = servicesMap[model.serviceName];
         if (!service) {
             logger_1.LOGGER.error("Invalid CAP service - undefined");
             return {
@@ -114,14 +113,7 @@ function assignUnboundOperation(params, model, server, authEnabled) {
         const response = await service
             .tx({ user: accessRights })
             .send(model.target, args);
-        return {
-            content: Array.isArray(response)
-                ? response.map((el) => ({
-                    type: "text",
-                    text: formatResponseValue(el),
-                }))
-                : [{ type: "text", text: formatResponseValue(response) }],
-        };
+        return (0, utils_1.asMcpResult)(response);
     });
 }
 /**

package/lib/mcp/utils.js

@@ -3,6 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.determineMcpParameterType = determineMcpParameterType;
 exports.handleMcpSessionRequest = handleMcpSessionRequest;
 exports.writeODataDescriptionForResource = writeODataDescriptionForResource;
+exports.toolError = toolError;
+exports.asMcpResult = asMcpResult;
 const constants_1 = require("./constants");
 const zod_1 = require("zod");
 /**
@@ -69,3 +71,57 @@ function writeODataDescriptionForResource(model) {
     }
     return description;
 }
+/**
+ * Unified MCP tool error response helper
+ * Returns a consistent JSON error payload inside MCP content
+ */
+function toolError(code, message, extra) {
+    const payload = { error: code, message, ...(extra || {}) };
+    return {
+        isError: true,
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(payload),
+            },
+        ],
+    };
+}
+/**
+ * Formats a payload as MCP result content with a single text part.
+ * This ensures compatibility with all MCP clients.
+ */
+function asMcpResult(payload) {
+    // Pretty-print for objects, stringify primitives, and split arrays into multiple parts
+    const toText = (value) => {
+        if (typeof value === "string")
+            return value;
+        if (value === undefined)
+            return "undefined";
+        try {
+            if (value !== null && typeof value === "object") {
+                return JSON.stringify(value, null, 2);
+            }
+            return String(value);
+        }
+        catch {
+            // Circular structures fall back to default string conversion
+            return String(value);
+        }
+    };
+    if (Array.isArray(payload)) {
+        if (payload.length === 0)
+            return { content: [] };
+        return {
+            content: payload.map((item) => ({ type: "text", text: toText(item) })),
+        };
+    }
+    return {
+        content: [
+            {
+                type: "text",
+                text: toText(payload),
+            },
+        ],
+    };
+}

package/lib/mcp.js

@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const cds_1 = __importDefault(require("@sap/cds"));
 const logger_1 = require("./logger");
 const types_js_1 = require("@modelcontextprotocol/sdk/types.js");
 const express_1 = __importDefault(require("express"));
@@ -14,8 +13,7 @@ const loader_1 = require("./config/loader");
 const session_manager_1 = require("./mcp/session-manager");
 const utils_2 = require("./auth/utils");
 /* @ts-ignore */
-// const cds = global.cds || require("@sap/cds"); // This is a work around for missing cds context
-// TODO: Handle auth
+const cds = global.cds; // Use hosting app's CDS instance exclusively
 /**
  * Main MCP plugin class that integrates CAP services with Model Context Protocol
  * Manages server sessions, API endpoints, and annotation processing
@@ -41,7 +39,7 @@ class McpPlugin {
     async onBootstrap(app) {
         logger_1.LOGGER.debug("Event received for 'bootstrap'");
         this.expressApp = app;
-        this.expressApp.use(express_1.default.json());
+        this.expressApp.use("/mcp", express_1.default.json());
         if (this.config.auth === "inherit") {
             (0, utils_2.registerAuthMiddleware)(this.expressApp);
         }
@@ -85,7 +83,26 @@ class McpPlugin {
         });
         this.registerMcpSessionRoute();
         this.expressApp?.get("/mcp", (req, res) => (0, utils_1.handleMcpSessionRequest)(req, res, this.sessionManager.getSessions()));
-        this.expressApp?.delete("/mcp", (req, res) => (0, utils_1.handleMcpSessionRequest)(req, res, this.sessionManager.getSessions()));
+        this.expressApp?.delete("/mcp", ((req, res) => {
+            const sessionIdHeader = req.headers[constants_1.MCP_SESSION_HEADER];
+            const sessions = this.sessionManager.getSessions();
+            if (!sessionIdHeader || !sessions.has(sessionIdHeader)) {
+                return res.status(400).json({
+                    jsonrpc: "2.0",
+                    error: {
+                        code: -32000,
+                        message: "Bad Request: No valid sessions ID provided",
+                        id: null,
+                    },
+                });
+            }
+            const session = sessions.get(sessionIdHeader);
+            // Fire-and-forget close operations
+            void session.transport.close();
+            void session.server.close();
+            sessions.delete(sessionIdHeader);
+            return res.status(200).json({ jsonrpc: "2.0", result: { closed: true } });
+        }));
     }
     /**
      * Registers the main MCP POST endpoint for session creation and request handling
@@ -94,7 +111,6 @@ class McpPlugin {
     registerMcpSessionRoute() {
         logger_1.LOGGER.debug("Registering MCP entry point");
         this.expressApp?.post("/mcp", async (req, res) => {
-            logger_1.LOGGER.debug("CONTEXT", cds_1.default.context); // TODO: Remove this line after testing
             const sessionIdHeader = req.headers[constants_1.MCP_SESSION_HEADER];
             logger_1.LOGGER.debug("MCP request received", {
                 hasSessionId: !!sessionIdHeader,
@@ -117,7 +133,9 @@ class McpPlugin {
                 return;
             }
             try {
+                const t0 = Date.now();
                 await session.transport.handleRequest(req, res, req.body);
+                logger_1.LOGGER.debug("MCP request handled", { durationMs: Date.now() - t0 });
                 return;
             }
             catch (e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gavdi/cap-mcp",
-  "version": "0.9.4",
+  "version": "0.9.8",
   "description": "MCP Pluging for CAP",
   "keywords": [
     "MCP",
@@ -22,6 +22,7 @@
   "repository": "github:gavdilabs/cap-mcp-plugin",
   "scripts": {
     "mock": "npm run start --workspace=test/demo",
+    "mock:watch": "npm run build && npm run watch --workspace=test/demo",
     "test": "NODE_ENV=test jest --silent",
     "test:unit": "NODE_ENV=test jest --silent test/unit",
     "test:integration": "NODE_ENV=test jest --silent test/integration",
@@ -30,7 +31,10 @@
     "prepare": "husky",
     "lint": "eslint",
     "lint-staged": "lint-staged",
-    "format": "prettier --check ./src"
+    "format": "prettier --check ./src",
+    "format:fix": "prettier --write ./src \"**/*.json\"",
+    "build:watch": "tsc --watch",
+    "release": "release-it"
   },
   "peerDependencies": {
     "@sap/cds": "^9",
@@ -43,6 +47,7 @@
   },
   "devDependencies": {
     "@cap-js/cds-types": "^0.12.0",
+    "@release-it/conventional-changelog": "^10.0.1",
     "@types/express": "^5.0.3",
     "@types/jest": "^30.0.0",
     "@types/node": "^24.0.3",
@@ -53,7 +58,7 @@
     "jest": "^29.7.0",
     "lint-staged": "^16.1.2",
     "prettier": "^3.5.3",
-    "release-it": "^19.0.3",
+    "release-it": "^19.0.4",
     "sinon": "^21.0.0",
     "supertest": "^7.0.0",
     "ts-jest": "^29.4.0",
@@ -62,15 +67,15 @@
   },
   "lint-staged": {
     "*.json": [
-      "prettier --check"
+      "prettier --write"
     ],
     "*.ts": [
       "eslint",
-      "prettier ./src --check"
+      "prettier --write"
     ],
     "*.js": [
       "eslint",
-      "prettier ./src --check"
+      "prettier --write"
     ]
   },
   "workspaces": [

package/lib/annotations.js

@@ -1,257 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.McpPromptAnnotation = exports.McpToolAnnotation = exports.McpResourceAnnotation = exports.McpAnnotation = exports.McpAnnotations = exports.McpAnnotationKey = void 0;
-exports.parseAnnotations = parseAnnotations;
-const utils_1 = require("./utils");
-const DEFAULT_ALL_RESOURCE_OPTIONS = new Set([
-    "filter",
-    "sort",
-    "top",
-    "skip",
-    "select",
-]);
-exports.McpAnnotationKey = "@mcp";
-exports.McpAnnotations = {
-    // Resource annotations for MCP
-    MCP_RESOURCE: "@mcp.resource",
-    // Tool annotations for MCP
-    MCP_TOOL_NAME: "@mcp.tool.name",
-    MCP_TOOL_DESCRIPTION: "@mcp.tool.description",
-    // Prompt annotations for MCP
-    MCP_PROMPT: "@mcp.prompt",
-};
-class McpAnnotation {
-    _target;
-    _serviceName;
-    constructor(target, serviceName) {
-        this._target = target;
-        this._serviceName = serviceName;
-    }
-    get target() {
-        return this._target;
-    }
-    get serviceName() {
-        return this._serviceName;
-    }
-}
-exports.McpAnnotation = McpAnnotation;
-class McpResourceAnnotation extends McpAnnotation {
-    _includeAll;
-    _functionalities;
-    _properties;
-    constructor(target, serviceName, includeAll, functionalities, properties) {
-        super(target, serviceName);
-        this._includeAll = includeAll;
-        this._functionalities = functionalities;
-        this._properties = properties;
-    }
-    get includeAll() {
-        return this._includeAll;
-    }
-    get functionalities() {
-        return this._functionalities;
-    }
-    get properties() {
-        return this._properties;
-    }
-}
-exports.McpResourceAnnotation = McpResourceAnnotation;
-class McpToolAnnotation extends McpAnnotation {
-    _name;
-    _description;
-    _parameters;
-    _entityKey;
-    _operationKind;
-    _keyTypeMap;
-    constructor(name, description, operation, serviceName, parameters, entityKey, operationKind, keyTypeMap) {
-        super(operation, serviceName);
-        this._name = name;
-        this._description = description;
-        this._parameters = parameters;
-        this._entityKey = entityKey;
-        this._operationKind = operationKind;
-        this._keyTypeMap = keyTypeMap;
-    }
-    get name() {
-        return this._name;
-    }
-    get description() {
-        return this._description;
-    }
-    get parameters() {
-        return this._parameters;
-    }
-    get entityKey() {
-        return this._entityKey;
-    }
-    get operationKind() {
-        return this._operationKind;
-    }
-    get keyTypeMap() {
-        return this._keyTypeMap;
-    }
-}
-exports.McpToolAnnotation = McpToolAnnotation;
-class McpPromptAnnotation extends McpAnnotation {
-    _name;
-    _template;
-    constructor(target, serviceName, name, template) {
-        super(target, serviceName);
-        this._name = name;
-        this._template = template;
-    }
-    get name() {
-        return this._name;
-    }
-    get template() {
-        return this._template;
-    }
-}
-exports.McpPromptAnnotation = McpPromptAnnotation;
-function parseAnnotations(services) {
-    const annotations = [];
-    for (const serviceName of Object.keys(services)) {
-        const srv = services[serviceName];
-        if (srv.name === "CatalogService") {
-            utils_1.LOGGER.debug("SERVICE: ", srv.model.definitions);
-        }
-        const entities = srv.entities;
-        const operations = srv.operations; // Refers to action and function imports
-        // Find entities
-        for (const entityName of Object.keys(entities)) {
-            const target = entities[entityName];
-            const res = findEntityAnnotations(target, entityName, srv);
-            if (target.actions) {
-                const bound = parseBoundOperations(target.actions, entityName, target, srv);
-                if (bound && bound.length > 0) {
-                    annotations.push(...bound);
-                }
-            }
-            if (!res)
-                continue;
-            annotations.push(res);
-        }
-        // Find operations
-        for (const operationName of Object.keys(operations)) {
-            const op = operations[operationName];
-            const res = findOperationAnnotations(op, operationName, srv);
-            if (!res)
-                continue;
-            annotations.push(res);
-        }
-    }
-    const result = formatAnnotations(annotations);
-    return result;
-}
-function formatAnnotations(annotationList) {
-    const result = new Map();
-    for (const annotation of annotationList) {
-        if (annotation.operation) {
-            if (!annotation.annotations[exports.McpAnnotations.MCP_TOOL_NAME] ||
-                !annotation.annotations[exports.McpAnnotations.MCP_TOOL_DESCRIPTION]) {
-                utils_1.LOGGER.error(`Invalid annotation found for operation`, annotation);
-                throw new Error(`Invalid annotations for operation '${annotation.operation}'`);
-            }
-            else if (typeof annotation.annotations[exports.McpAnnotations.MCP_TOOL_NAME] !==
-                "string" ||
-                typeof annotation.annotations[exports.McpAnnotations.MCP_TOOL_DESCRIPTION] !==
-                    "string") {
-                utils_1.LOGGER.error("Invalid data for annotations", annotation);
-                throw new Error(`Invalid annotation data for operation '${annotation.operation}'`);
-            }
-            const entry = new McpToolAnnotation(annotation.annotations[exports.McpAnnotations.MCP_TOOL_NAME], annotation.annotations[exports.McpAnnotations.MCP_TOOL_DESCRIPTION], annotation.operation, annotation.serviceName, mapOperationInput(annotation.context), // TODO: Parse the parameters from the context and place them in the class
-            annotation.entityKey, annotation.operationKind, annotation.keyTypeMap);
-            result.set(entry.target, entry);
-            continue;
-        }
-        if (!annotation.entityKey) {
-            utils_1.LOGGER.error("Invalid entry", annotation);
-            throw new Error(`Invalid annotated entry found with no target`);
-        }
-        if (!annotation.annotations[exports.McpAnnotations.MCP_RESOURCE]) {
-            utils_1.LOGGER.error("No valid annotations found for entry", annotation);
-            throw new Error(`Invalid annotations for entry target: '${annotation.entityKey}'`);
-        }
-        const includeAll = annotation.annotations[exports.McpAnnotations.MCP_RESOURCE] === true;
-        const functionalities = Array.isArray(annotation.annotations[exports.McpAnnotations.MCP_RESOURCE])
-            ? new Set(annotation.annotations[exports.McpAnnotations.MCP_RESOURCE])
-            : DEFAULT_ALL_RESOURCE_OPTIONS;
-        const entry = new McpResourceAnnotation(annotation.entityKey, annotation.serviceName, includeAll, functionalities, (0, utils_1.parseEntityElements)(annotation.context));
-        result.set(entry.target, entry);
-    }
-    utils_1.LOGGER.debug("Formatted annotations", result);
-    return result;
-}
-function findEntityAnnotations(entry, entityKey, service) {
-    const annotations = findAnnotations(entry);
-    return Object.keys(annotations).length > 0
-        ? {
-            serviceName: service.name,
-            annotations: annotations,
-            entityKey: entityKey,
-            context: entry,
-        }
-        : undefined;
-}
-function findOperationAnnotations(operation, operationName, service) {
-    const annotations = findAnnotations(operation);
-    return Object.keys(annotations).length > 0
-        ? {
-            serviceName: service.name,
-            annotations: annotations,
-            operation: operationName,
-            operationKind: operation.kind,
-            context: operation,
-        }
-        : undefined;
-}
-function parseBoundOperations(operations, entityKey, entity, service) {
-    const res = new Array();
-    for (const [operationName, operation] of Object.entries(operations)) {
-        const annotation = findBoundOperationAnnotations(operation, operationName, entityKey, service);
-        if (!annotation)
-            continue;
-        annotation.keyTypeMap = new Map();
-        for (const [k, v] of Object.entries(entity.keys)) {
-            if (!v.type) {
-                utils_1.LOGGER.error("Invalid key type", k);
-                throw new Error("Invalid key type found for bound operation");
-            }
-            annotation.keyTypeMap.set(k, v.type.replace("cds.", ""));
-        }
-        res.push(annotation);
-    }
-    return res;
-}
-function findBoundOperationAnnotations(operation, operationName, entityKey, service) {
-    const annotations = findAnnotations(operation);
-    return Object.keys(annotations).length > 0
-        ? {
-            serviceName: service.name,
-            annotations: annotations,
-            operation: operationName,
-            operationKind: operation.kind,
-            entityKey: entityKey,
-            context: operation,
-        }
-        : undefined;
-}
-function findAnnotations(entry) {
-    const annotations = {};
-    for (const [k, v] of Object.entries(entry)) {
-        if (!k.includes(exports.McpAnnotationKey))
-            continue;
-        annotations[k] = v;
-    }
-    return annotations;
-}
-function mapOperationInput(ctx) {
-    const params = ctx["params"];
-    if (!params)
-        return undefined;
-    const result = new Map();
-    for (const [k, v] of Object.entries(params)) {
-        result.set(k, v.type.replace("cds.", ""));
-    }
-    return result.size > 0 ? result : undefined;
-}

package/lib/auth/adapter.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/auth/mock.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/auth/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });