@arpproject/vibearp-mcp 1.2.0

package/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 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.

package/README.md

@@ -0,0 +1,158 @@
+# VibeARP MCP Server
+
+`@arpproject/vibearp-mcp` is an [MCP server](https://www.dreamfactory.com/use-cases/mcp-server/) for [RO-Crate](https://www.researchobject.org/ro-crate/) editing, validation, and profile-aware constraints following the best practices of the ARP project (https://researchdata.hu/). It is designed to be used with MCP-compatible AI assistants such as Codex, Claude Code. It can be used with the schemas and profiles offered by the ARP Schema Registry (https://cedar.schema.researchdata.hu/)
+
+[Quick start](#quick-start) · [Első lépések](#első-lépések)
+
+## Quick start
+
+`@arpproject/vibearp-mcp` makes it easy to create RO-Crate packages using MCP-compatible AI assistants and subsequently upload them to the ARP system.
+
+To use it, you need an MCP-compatible AI assistant, such as Codex, Claude Code, OpenCode, Kilo Code, Roo Code, Gemini CLI, or Qwen Code.
+
+Node.js 18 or newer is required for installation:
+
+```bash
+npm install -g @arpproject/vibearp-mcp
+```
+
+Note: when upgrading an existing installation, the package first asks the
+shared RO-Crate MCP daemon to shut down gracefully through its socket (or
+Windows named pipe). Restart any AI  assistant that already has an MCP connection 
+after the upgrade.
+
+To configure it for a particular AI assistant, use the interactive installer:
+
+```bash
+rocrate-mcp-server -i
+```
+
+Select the AI assistant you want to use, and the installer will automatically create the required configuration.
+
+The selection screen supports the up/down arrow keys as well as entering an
+agent number. Before asking for confirmation, the installer displays the exact
+MCP section it will write and the destination file. Press Enter to accept, or use an explicit 
+agent ID when preferred:
+
+```bash
+rocrate-mcp-server -i codex
+```
+
+Supported IDs are `codex`, `claude`, `opencode`, `kilo`, `roo`, `gemini`, and
+`qwen`. The generated configuration launches the standalone server through the
+shared per-user RockIT socket (`~/.rockit/rocrate-mcp-server.sock`).
+
+The standalone server and RocKIT share the same per-user profile and schema
+storage by default: `~/.rockit`. Set `ROCKIT_ROOT_PATH` to use another shared
+root, and use the `ROCKIT_*` profile environment variables for filename and
+provider-storage overrides.
+
+You can verify that the installation was successful by starting the AI assistant and listing the configured MCP servers. This is typically done using the `/mcp` command (for example, in Codex and Claude Code) or `/mcps` (for example, in OpenCode). The list should contain an MCP server named `rocrate` that runs the `rocrate-mcp-server` command.
+
+To use `rocrate-mcp-server`, start your AI assistant in the directory where you want to create or edit the RO-Crate. Give the assistant the appropriate instructions for creating the RO-Crate package, and it will automatically start using `rocrate-mcp-server` and follow the workflows provided by the server.If RO-Crate editing is not using the MCP server automatically, you can explcitily ask the assistant to "Use the RO-Crate MCP server" to start using it.
+
+At the end of the workflow, the completed RO-Crate package (the `ro-crate-metadata.json` file) can be opened in the ARP AROMA software. The assistant will usually offer to do this automatically. If it does not, simply ask it to
+```
+ "Open the dataset in AROMA".
+```
+
+The assistant will provide a URL that opens AROMA in a browser with the RO-Crate package you are currently editing, or in case of a more intelligent agent, it may even open the browser automatically.
+
+If you place the AI assistant and the AROMA browser window side by side, changes made to the RO-Crate through the assistant will immediately appear in AROMA, where they can be reviewed and also edited directly. It is also to a good experience to work in a desktop app, like ChatGPT dekstop, and have the AROMA browser window open inside the app. The built-in browser can also be used to perform tasks, whichrequire interactive browser access, ie. "browser use"
+
+The server also provides a local dashboard at `http://127.0.0.1:9393` for
+monitoring MCP activity and configure various values.
+
+`rocrate-mcp-server` can also upload the dataset to ARP Dataverse; simply ask your assistant to do so. For uploads to work, set the `DATAVERSE_API_KEY` environment variable. You can get it from https://repo.researchdata.hu/dataverseuser.xhtml?selectTab=apiTokenTab. The assistant will also ask for this value if they have not been configured.
+
+The dashboard Settings page lets you enter or override the `TAVILY_API_KEY`,
+`DATAVERSE_BASE_URL`, and `DATAVERSE_API_KEY` values for the running MCP
+process, and controls whether successful Dataverse uploads keep their generated
+RO-Crate ZIP files. Environment variables remain the defaults; dashboard
+settings are saved in `~/.rockit/rocrate-mcp-settings.json`. 
+API-key overrides can be cleared from Settings to restore the
+environment fallback. The file contains configured API keys in plaintext and
+uses user-only permissions where supported.
+
+## Első lépések
+
+Az `@arpproject/vibearp-mcp` segítségével MCP-kompatibilis AI-asszisztenseket használva egyszerűen hozhatók létre RO-Crate csomagok, amelyeket aztán az ARP rendszerébe is fel lehet tölteni.
+
+A használatához szükség van egy MCP-kompatibilis AI-asszisztensre, például Codex, Claude Code, OpenCode, Kilo Code, Roo Code, Gemini CLI vagy Qwen Code.
+
+A telepítéshez Node.js 18 vagy újabb szükséges:
+
+```bash
+npm install -g @arpproject/vibearp-mcp
+```
+
+Megjegyzés: meglévő telepítés frissítésekor a csomag először szabályosan
+leállítja a közös RO-Crate MCP démont a socketen (Windowson named pipe-on)
+keresztül. A frissítés után indítsd újra azt az AI-asszisztenst, amely már
+az új szervert fogja elindítani és használni.
+
+Egy adott AI-asszisztenshez való konfiguráláshoz használd az interaktív telepítőt:
+
+```bash
+rocrate-mcp-server -i
+```
+
+Itt válaszd ki a használni kívánt AI-asszisztenst, és a telepítő automatikusan beállítja a szükséges konfigurációt.
+
+A választóképernyőn a fel/le nyilakkal és a sorszám megadásával is
+navigálhatsz. A telepítő a megerősítés előtt megmutatja a pontosan kiírandó MCP
+szekciót és a célfájlt. Az elfogadáshoz nyomd meg az Enter billentyűt. Ha adott ágenshez akarod közvetlenül telepíteni, add meg az asszisztens azonosítóját:
+
+```bash
+rocrate-mcp-server -i codex
+```
+
+Az elérhető azonosítók: `codex`, `claude`, `opencode`, `kilo`, `roo`, `gemini`
+és `qwen`. A létrehozott konfiguráció a standalone szervert a közös,
+felhasználónkénti RockIT socketen (`~/.rockit/rocrate-mcp-server.sock`) keresztül
+indítja.
+
+A standalone szerver és a RocKIT alapértelmezés szerint ugyanazt a
+felhasználónkénti profil- és séma-tárolót használja: `~/.rockit`. Másik közös
+gyökérhez állítsd be a `ROCKIT_ROOT_PATH` változót; a fájlnév- és szolgáltató-
+felülírásokhoz használd a `ROCKIT_*` profil-környezeti változókat.
+
+A sikeres telepítést úgy ellenőrizheted, hogy elindítod az AI-asszisztenst, és listázod a beállított MCP-szervereket. Ehhez tipikusan az `/mcp` (például Codex és Claude Code esetében) vagy az `/mcps` (például OpenCode esetében) parancsot kell kiadni. A listában meg kell jelennie a `rocrate` nevű MCP-szervernek, amely a `rocrate-mcp-server` parancsot futtatja.
+
+A `rocrate-mcp-server` használatához az AI-asszisztenst abban a könyvtárban indítsd el, ahol a RO-Crate-et létre szeretnéd hozni vagy szerkeszteni. Add meg az RO-Crate csomag létrehozásához a megfelelő utasítást, és az asszisztens automatikusan elkezdi használni a `rocrate-mcp-server`-t, követve az abban meghatározott munkafolyamatokat. Ha a RO-Crate szerkesztésekor az MCP-szerver nem indul el automatikusan, kérd meg kifejezetten az asszisztenst a következőre: „Használd az RO-Crate MCP-t!”.
+
+A munkafolyamat végén az elkészült RO-Crate csomag (a `ro-crate-metadata.json` fájl) megnyitható az ARP AROMA szoftverben. Ezt általában automatikusan felajánlja az asszisztens. Ha nem, akkor csak kérd meg:
+```
+„   Nyisd meg az adatcsomagot az AROMA-ban”.
+```
+
+Ennek hatására az asszisztens ad egy URL-t, amelyre kattintva a böngészőben megnyílik az AROMA az éppen szerkesztett RO-Crate csomaggal, intelligensebb ügynök esetén pedig akár automatikusan meg is nyithatja a böngészőt.
+
+Ha az AI-asszisztenst és a megnyitott AROMA böngészőablakot egymás mellé helyezed, akkor az asszisztenssel végzett módosítások azonnal megjelennek az AROMA-ban is, ahol ellenőrizhetők, illetve közvetlenül szerkeszthetők. Jó megoldás lehet egy asztali alkalmazásban, például a ChatGPT asztali alkalmazásában dolgozni, és az AROMA böngészőablakát az alkalmazáson belül megnyitni. A beépített böngésző olyan feladatok elvégzésére is használható, amelyek interaktív böngésző-hozzáférést igényelnek, például a „browser use”.
+
+A szerver helyi vezérlőpultot is biztosít a MCP-tevékenység megfigyeléséhez a
+`http://127.0.0.1:9393` címen, ahol különböző értékek is beállíthatók.
+
+A `rocrate-mcp-server` használatával az adatcsomag az ARP Dataverse-be is feltölthető; ehhez csak kérd meg az asszisztenst. A feltöltéshez állítsd be a `DATAVERSE_API_KEY` környezeti változót. Ezt a https://repo.researchdata.hu/dataverseuser.xhtml?selectTab=apiTokenTab oldalon tudod beszerezni. Ha nincs ez a környezeti változó beállítva, az asszisztens is bekérheti.
+
+A vezérlőpult Beállítások oldala lehetővé teszi a `TAVILY_API_KEY`,
+`DATAVERSE_BASE_URL` és `DATAVERSE_API_KEY` értékek megadását vagy felülírását
+az éppen futó MCP-folyamatban, valamint a sikeres Dataverse-feltöltések során
+keletkező RO-Crate ZIP-fájlok megtartásának beállítását. Alapértelmezés szerint
+a környezeti változók használatosak; a vezérlőpult beállításai a
+`~/.rockit/rocrate-mcp-settings.json` fájlba kerülnek. Az API-kulcsok felülírásai a Beállítások oldalán törölhetők
+a környezeti változók visszaállításához. A fájl a beállított API-kulcsokat
+egyszerű szövegként tartalmazza, és ahol támogatott, csak a felhasználó számára
+engedélyezett hozzáféréssel rendelkezik.
+
+## Authorship
+
+This package is maintained by SZTAKI, Department of Distributed Systems
+(<https://dsd.sztaki.hu>).
+
+Individual contributors are listed in `package.json`.
+
+## License
+
+This package is licensed under the Apache License, Version 2.0. See
+[LICENSE.md](./LICENSE.md) for details.