diff --git a/README.md b/README.md index a400e81c..ef384ad7 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ Each plugin lives in `plugins/`. The directory name is the install keyword | `linear` | Linear SDK scripting skill for issue, project, team, cycle, and comment workflows. | | `mac-notify` | macOS notifications when a Cline run completes. | | `nanobanana` | Image generation through OpenRouter and Gemini image models. | +| `sap-fiori` | SAP Fiori MCP tools plus visual filter guidance for CAP, UI5, and ABAP RAP projects. | | `speak` | Speaks completed Cline replies with ElevenLabs text to speech. | | `typescript-lsp` | TypeScript language service `goto_definition` support. | | `weather-metrics` | Demo weather tool plus runtime metrics hooks. | diff --git a/plugins/sap-fiori/LICENSE.sap-fiori-mcp-server b/plugins/sap-fiori/LICENSE.sap-fiori-mcp-server new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/plugins/sap-fiori/LICENSE.sap-fiori-mcp-server @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/plugins/sap-fiori/NOTICE.sap-fiori-mcp-server b/plugins/sap-fiori/NOTICE.sap-fiori-mcp-server new file mode 100644 index 00000000..77101de0 --- /dev/null +++ b/plugins/sap-fiori/NOTICE.sap-fiori-mcp-server @@ -0,0 +1,4 @@ +This plugin includes adapted skill material from SAP's sap-fiori-mcp-server plugin. + +Source: https://github.com/SAP/open-ux-tools/tree/main/packages/fiori-mcp-server +License: Apache-2.0 diff --git a/plugins/sap-fiori/README.md b/plugins/sap-fiori/README.md new file mode 100644 index 00000000..5f8b6fb1 --- /dev/null +++ b/plugins/sap-fiori/README.md @@ -0,0 +1,38 @@ +# sap-fiori + +SAP Fiori app generation, modification, documentation lookup, and visual filter guidance for Cline. + +## What It Does + +This plugin registers the `fiori-mcp` MCP server from `@sap-ux/fiori-mcp-server` and bundles a SAP Fiori visual filter skill. + +The MCP server can search SAP Fiori elements, annotation, UI5, and SAP Fiori tools documentation, list existing Fiori apps in a workspace, inspect supported Fiori app-generation and modification workflows, and execute those workflows when the user confirms the target app and file changes. + +The bundled skill helps add chart-based visual filters to SAP Fiori elements filter bars and value help dialogs for CAP and ABAP RAP projects. + +## Install + +```bash +cline plugin install sap-fiori +``` + +For local development from this repository: + +```bash +cline plugin install ./plugins/sap-fiori --cwd . +``` + +## Requirements + +- Node.js and `npx` for launching the MCP server. When the MCP server starts, `npx` may download and execute `@sap-ux/fiori-mcp-server@1.2.0` from npm if it is not already cached. +- SAP Fiori, UI5, CAP, or ABAP RAP project files in the workspace for project modification workflows. +- SAP system access only when the requested workflow needs live metadata or an existing OData service. +- A trusted CA certificate for SAP systems that use a private or self-signed certificate. + +## Security Notes + +The plugin instructs Cline to confirm project writes, generated app changes, metadata refreshes, SAP system access, package installs, and watcher commands before execution. It also prefers custom CA certificates over disabling TLS verification. + +## Attribution + +The bundled visual filter skill is derived from SAP's `sap-fiori-mcp-server` plugin materials, licensed under Apache-2.0. See `LICENSE.sap-fiori-mcp-server` and `NOTICE.sap-fiori-mcp-server`. diff --git a/plugins/sap-fiori/index.ts b/plugins/sap-fiori/index.ts new file mode 100644 index 00000000..f433b847 --- /dev/null +++ b/plugins/sap-fiori/index.ts @@ -0,0 +1,29 @@ +import type { AgentPlugin } from "@cline/sdk" + +const plugin: AgentPlugin = { + name: "sap-fiori", + manifest: { + capabilities: ["skills", "mcp"], + }, + + setup(api) { + api.registerMcpServer({ + name: "fiori-mcp", + transport: { + type: "stdio", + command: "npx", + args: [ + "--yes", + "@sap-ux/fiori-mcp-server@1.2.0", + "fiori-mcp", + ], + }, + metadata: { + description: + "SAP Fiori tools for discovering Fiori apps, searching Fiori/UI5 documentation, and creating or modifying Fiori elements applications.", + }, + }) + }, +} + +export default plugin diff --git a/plugins/sap-fiori/package.json b/plugins/sap-fiori/package.json new file mode 100644 index 00000000..fff8a9ff --- /dev/null +++ b/plugins/sap-fiori/package.json @@ -0,0 +1,20 @@ +{ + "name": "sap-fiori", + "version": "0.0.0", + "private": true, + "type": "module", + "description": "Cline plugin for SAP Fiori app generation, modification, documentation lookup, and visual filter guidance.", + "cline": { + "plugins": [ + { + "paths": [ + "./index.ts" + ], + "capabilities": [ + "skills", + "mcp" + ] + } + ] + } +} diff --git a/plugins/sap-fiori/skills/sap-fiori-add-visual-filter/SKILL.md b/plugins/sap-fiori/skills/sap-fiori-add-visual-filter/SKILL.md new file mode 100644 index 00000000..58695728 --- /dev/null +++ b/plugins/sap-fiori/skills/sap-fiori-add-visual-filter/SKILL.md @@ -0,0 +1,243 @@ +--- +name: sap-fiori-add-visual-filter +description: Add visual filters (chart-based) to SAP Fiori Elements filter bar/value help using CAP or ABAP RAP. +metadata: + author: sap-fiori-tools + version: "0.0.4" +--- + +# SAP Fiori Visual Filter + +## Purpose +Add chart-based filters (Bar/Line) to filter bar or value help dialog (OData V4). + +--- + +## MANDATORY: Gather Required Inputs First + +STOP and ask the user for all of these inputs if any are missing from the prompt: + +1. Entity - Which entity to add the visual filter to +2. Dimension field - The field to filter by (e.g., Category, Status, Destination) +3. Measure field - The numeric field to aggregate (e.g., Amount, TotalPrice, ReservationPrice) +4. Aggregation method - How to aggregate: sum, avg, min, or max +5. Chart type - Bar or Line (recommend Bar as default) + +Do not proceed with implementation until all inputs are confirmed. + +Before writing files, running the SAP Fiori MCP server's execute workflow, refreshing metadata, contacting SAP systems, or starting local watch commands, confirm the target project, app, service, expected file changes, and whether the user wants the action executed now. + +--- + +## CAP Implementation + + +### Enable Aggregation (MANDATORY) +```cds +@Aggregation.ApplySupported: { + Transformations: ['aggregate','groupby'], + AggregatableProperties: [{ Property: Amount }], + GroupableProperties: [Category] +} +``` + +### Aggregated Property (Measure) +```cds +Analytics.AggregatedProperty #Amount_sum : { + $Type: 'Analytics.AggregatedPropertyType', + Name: 'Amount_sum', + AggregatableProperty: Amount, + AggregationMethod: 'sum' +} +``` + +### Chart Annotation +```cds +UI.Chart #visualFilter : { + ChartType: #Bar, + Dimensions: [Category], + DynamicMeasures: ['@Analytics.AggregatedProperty#Amount_sum'] +} +``` + +Uses DynamicMeasures. + +### PresentationVariant +```cds +UI.PresentationVariant #visualFilter: { + Visualizations: ['@UI.Chart#visualFilter'] +} +``` + +### ValueList (on Dimension Field) +```cds +Category @Common.ValueList #visualFilter: { + $Type: 'Common.ValueListType', + CollectionPath: 'EntityName', + Parameters: [ + { $Type: 'Common.ValueListParameterInOut', LocalDataProperty: Category, ValueListProperty: 'Category' } + ], + PresentationVariantQualifier: 'visualFilter' +} +``` + +### SelectionFields +```cds +UI.SelectionFields: [Category] +``` + +--- + +## ABAP RAP Implementation + +- Aggregation.ApplySupported and Aggregation.CustomAggregate annotations must be available in metadata.xml (RAP). If not, below backend configuration is required. + +### Backend CDS (MANDATORY) +```abap +@OData.applySupportedForAggregation: #FULL +define root view entity ZC_ENTITY + provider contract analytical_query + as projection on ZI_ENTITY +{ + key EntityID, + + @Aggregation.default: #SUM + Amount, + + Category +} +``` + +### Chart Annotation +```xml + + + + + + Category + + + + + Amount + + + + +``` + +Uses Measures, not DynamicMeasures. + +Metadata is read-only. + +### PresentationVariant Annotation +```xml + + + + + @UI.Chart#visualFilter + + + + +``` + +### ValueList Annotation +```xml + + + + + + + + + + + + + + +``` + +### SelectionFields Annotation +```xml + + + Category + + +``` + +--- + +## Manifest Configuration (REQUIRED) +```json +"@com.sap.vocabularies.UI.v1.SelectionFields": { + "layout": "CompactVisual", + "initialLayout": "Visual", + "filterFields": { + "Category": { + "visualFilter": { + "valueList": "com.sap.vocabularies.Common.v1.ValueList#visualFilter" + } + } + } +} +``` + +Connects filter field to visual filter chart. + +Sets initial layout to visual mode. + +--- + +## Testing + +### CAP Projects +```bash +npm run watch- # e.g., npm run watch-manage-travel +# or use generic watch script if available +cds watch +``` + +### RAP Projects +```bash +npm run start-mock # Needs metadata refresh + +npm start # No refresh needed - fetches metadata from live backend at runtime +``` +- Consult the Fiori MCP server if available on how to refresh metadata for SAP or cloud systems in case of RAP. Confirm before contacting live SAP systems. + +--- + +## Key Differences + +- CAP: DynamicMeasures + AggregatedProperty defined in CDS +- RAP: Measures + @Aggregation.default in backend CDS only +- CAP: Aggregation and chart defined in same place +- RAP: Metadata is read-only, must be configured in backend CDS. +- Qualifier: Must use same qualifier (#visualFilter) across Chart, ValueList, and manifest + +--- + +## Common Mistakes + +- Missing backend aggregation setup +- Qualifier mismatch between Chart, ValueList, PresentationVariant, and manifest +- Wrong path in manifest (use full vocabulary path) +- RAP projects using DynamicMeasures instead of Measures +- Forgetting PresentationVariantQualifier in ValueList +- Missing SelectionFields annotation + +--- + +## Best Practices + +- Use Bar chart (most common and recommended) +- Limit to 3-5 visual filters per filter bar +- Always configure backend aggregation first +- Use consistent qualifiers throughout +- Test with real data to verify aggregation works correctly