@sap-ux/fiori-mcp-server 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,170 @@
+import type { ApplicationAccess, ProjectType } from '@sap-ux/project-access';
+/**
+ * Types for Fiori functionality
+ */
+/**
+ * Input interface for the 'list-fiori-apps' functionality
+ */
+export interface ListFioriAppsInput {
+    /** Array of paths to search for Fiori applications */
+    searchPath: string[];
+}
+/**
+ * Output interface for the 'list-fiori-apps' functionality
+ */
+export interface ListFioriAppsOutput {
+    /** Array of found Fiori applications */
+    applications: FioriApp[];
+}
+/**
+ * Input interface for the 'list-functionality' functionality
+ */
+export interface ListFunctionalitiesInput {
+    /** Path to the Fiori application */
+    appPath: string;
+}
+/**
+ * Output interface for the 'list-functionality' functionality
+ */
+export interface ListFunctionalitiesOutput {
+    /** Path to the Fiori application */
+    applicationPath: string;
+    /** Array of available functionalities */
+    functionalities: Functionality[];
+}
+/**
+ * Input interface for the 'get-functionality-details' functionality
+ */
+export interface GetFunctionalityDetailsInput {
+    /** Path to the Fiori application */
+    appPath: string;
+    /** ID or array of IDs of the functionality(ies) */
+    functionalityId: string | string[];
+}
+/**
+ * Output interface for the 'get-functionality-details' functionality
+ */
+export interface GetFunctionalityDetailsOutput {
+    /** ID of the functionality */
+    functionalityId: string;
+    /** Name of the functionality */
+    name: string;
+    /** Description of the functionality */
+    description: string;
+    /** Technical description of the functionality */
+    technicalDescription?: string;
+    /** Array of parameters for the functionality */
+    parameters: Parameter[];
+    /** Array of prerequisites for the functionality */
+    prerequisites?: string[];
+    /** Impact of the functionality */
+    impact?: string;
+    /** Array of examples for the functionality */
+    examples?: string[];
+    /** Name of the page associated with the functionality */
+    pageName?: string;
+}
+/**
+ * Input interface for the 'execute-functionality' functionality
+ */
+export interface ExecuteFunctionalitiesInput {
+    /** ID or array of IDs of the functionality(ies) to execute */
+    functionalityId: string | string[];
+    /** Parameters for the functionality execution */
+    parameters: {
+        [key: string]: unknown;
+    };
+    /** Path to the Fiori application */
+    appPath: string;
+}
+/**
+ * Output interface for the 'execute-functionality' functionality
+ */
+export interface ExecuteFunctionalityOutput {
+    /** ID or array of IDs of the executed functionality(ies) */
+    functionalityId: string | string[];
+    /** Status of the execution */
+    status: string;
+    /** Message describing the execution result */
+    message: string;
+    /** Parameters used in the execution */
+    parameters: unknown;
+    /** Path to the Fiori application */
+    appPath: string;
+    /** Array of changes made during the execution */
+    changes: string[];
+    /** Timestamp of the execution */
+    timestamp: string;
+}
+/**
+ * Interface representing a Fiori application
+ */
+export interface FioriApp {
+    /** Name of the Fiori application */
+    name: string;
+    /** Path to the Fiori application */
+    appPath: string;
+    /** Path to project */
+    projectPath: string;
+    /** Type of the Fiori project */
+    projectType: ProjectType;
+    /** OData version of the Fiori application */
+    odataVersion: string;
+}
+/**
+ * Interface representing a functionality
+ */
+export interface Functionality {
+    /** ID or array of IDs for the functionality */
+    functionalityId: Array<string | number> | string;
+    /** Description of the functionality */
+    description: string;
+}
+/**
+ * Interface representing a parameter
+ */
+export interface Parameter {
+    /** ID of the parameter */
+    id: string;
+    /** Name of the parameter */
+    name?: string;
+    /** Type of the parameter */
+    type: 'string' | 'number' | 'boolean' | 'array' | 'object';
+    /** Whether the parameter is required */
+    required?: boolean;
+    /** Description of the parameter */
+    description?: string;
+    /** Default value of the parameter */
+    defaultValue?: unknown;
+    /** Possible options for the parameter */
+    options?: Array<string | number | boolean | undefined>;
+    /** Current value of the parameter */
+    currentValue?: unknown;
+    /** Examples for the parameter */
+    examples?: string[];
+    /** Regex pattern to validate the value of this parameter */
+    pattern?: string;
+    /** Nested parameters (for 'object' type) */
+    parameters?: Parameter[];
+}
+/**
+ * Interface for functionality handlers
+ */
+export interface FunctionalityHandlers {
+    /** Handler for getting functionality details */
+    getFunctionalityDetails: (params: GetFunctionalityDetailsInput) => Promise<GetFunctionalityDetailsOutput>;
+    /** Handler for executing functionality */
+    executeFunctionality: (params: ExecuteFunctionalitiesInput) => Promise<ExecuteFunctionalityOutput>;
+}
+/**
+ * Interface representing application details
+ */
+export interface Appdetails {
+    /** Root path of the application */
+    root: string;
+    /** ID of the application */
+    appId: string;
+    /** Access details for the application */
+    applicationAccess?: ApplicationAccess;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@sap-ux/fiori-mcp-server",
+  "description": "SAP Fiori - Model Context Protocol (MCP) server",
+  "version": "0.0.1",
+  "keywords": [
+    "SAP Fiori tools",
+    "SAP Fiori elements",
+    "SAP Fiori freestyle",
+    "MCP",
+    "AI"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/fiori-mcp-server"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Afiori-mcp-server"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "!dist/**/*.map"
+  ],
+  "bin": {
+    "fiori-mcp": "./dist/index.js"
+  },
+  "devDependencies": {
+    "@types/json-schema": "7.0.5",
+    "@types/mem-fs": "1.1.2",
+    "@sap-ux/i18n": "0.3.3",
+    "@sap-ux/text-document-utils": "0.3.1",
+    "@sap-ux/odata-annotation-core-types": "0.4.5",
+    "@sap-ux/odata-entity-model": "0.3.1"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "1.17.4",
+    "@sap/ux-specification": "1.136.4",
+    "@sap-ux/annotation-converter": "0.10.3",
+    "i18next": "25.3.0",
+    "zod": "4.1.5",
+    "@sap-ux/project-access": "1.30.13",
+    "@sap-ux/nodejs-utils": "0.2.3",
+    "@sap-ux/fiori-annotation-api": "0.6.17"
+  },
+  "engines": {
+    "node": ">=20.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc --watch",
+    "bundle": "npm-run-all build tgz:package tgz:rename",
+    "tgz:package": "pnpm pack",
+    "tgz:rename": "node -e \"const fs=require('fs'), p=require('./package.json'), d=new Date().toISOString().split('T')[0], oldName=p.name.startsWith('@') ? `${p.name.replace('@', '').replace('/', '-')}-${p.version}.tgz` : `${p.name}-${p.version}.tgz`; fs.renameSync(oldName, `${oldName.replace('.tgz','')}-${d}.tgz`)\"",
+    "clean": "rimraf --glob dist test/test-output *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors"
+  }
+}