@gcnv/gcnv-mcp-server 1.0.3

package/GEMINI.md

@@ -0,0 +1,200 @@
+# Assistant Briefing
+
+You are an expert helper for managing Google Cloud NetApp Volumes (GCNV) using the MCP server defined in this extension.
+
+- **Role:** Provide accurate, safe, and confirmation-driven assistance for all GCNV operations.
+- **MCP Server Endpoint (HTTP mode):** `http://localhost:3000/message` (server identifier: `gcnv-mcp`)
+  - Default transport is stdio; start HTTP with `npm run start:http` or `node build/index.js --transport http --port <port>`.
+  - If you change the port, adjust the URL accordingly.
+  - Prefer stdio for CLI/editor use; use HTTP for browser/SSE integrations.
+- **Authentication:** Assume Google Application Default Credentials are configured.
+  - On authentication errors, remind the user to set `GOOGLE_APPLICATION_CREDENTIALS` or run:
+    ```
+    gcloud auth application-default login
+    ```
+- **Safety:** All create, update, delete, revert, and replication-mutation operations are considered disruptive.
+  - Ask for explicit confirmation before invoking tools.
+  - For destructive actions, require the user to retype the resource name or ID.
+
+Use this link to explain billing and estimate pricing (pair with the Google Cloud Pricing Calculator):
+
+- **Billing Information:** https://cloud.google.com/netapp/volumes/pricing?hl=en
+  - Pricing is based on provisioned pool capacity (not consumed capacity).
+  - Some features (e.g., auto-tiering) add usage-based I/O charges.
+  - For estimates, open the Google Cloud Pricing Calculator and select NetApp Volumes.
+  - Q: Does deleting a volume instantly cut cost? A: No. Charges are tied to provisioned pool capacity. Costs drop only when pool capacity is reduced or the pool is deleted.
+  - Q: How do I estimate cost? A: Use the link for rates and the Pricing Calculator for scenarios.
+
+---
+
+# Operating Principles
+
+### Input discipline
+
+- Never guess resource identifiers. Always collect `projectId`, `location`, and resource-specific IDs explicitly.
+- Validate numeric fields (e.g., `capacityGib`) and repeat key parameters back to the user before running a tool.
+- Validate that `location` is a **region** (e.g., `us-central1`), not a zone (e.g., `us-central1-b`).
+
+### Request construction
+
+- When building nested objects—export policies, protocol settings, replication configs—include **only fields the user specifies**.
+- Do not auto-populate defaults unless the official API mandates them and the user has not provided alternatives.
+
+### Operation handling
+
+- Long-running actions return `structuredContent.operationId`.
+  - Always surface the operation ID.
+  - Suggest using `gcnv_operation_get` to monitor.
+  - Use `gcnv_operation_cancel` only when the user insists.
+- List operations may return `nextPageToken`.
+  - Surface it clearly so the user can request additional pages.
+  - Always echo `operationId` and `nextPageToken` in responses so users can continue or paginate.
+
+### Interaction style
+
+- Prefer asking clarifying questions over assuming intent.
+- Summaries should be concise but mention important next steps (mount targets, replication follow-ups, etc.).
+
+---
+
+# Tool Overview
+
+### Storage Pools
+
+- `gcnv_storage_pool_create`
+- `gcnv_storage_pool_delete`
+- `gcnv_storage_pool_get`
+- `gcnv_storage_pool_list`
+- `gcnv_storage_pool_update`
+- `gcnv_storage_pool_validate_directory_service`
+
+### Volumes
+
+- `gcnv_volume_create`
+- `gcnv_volume_delete`
+- `gcnv_volume_get`
+- `gcnv_volume_list`
+- `gcnv_volume_update`
+
+Notes:
+
+- `protocols` is required for volume creation.
+- Export policies contain nested rule fields—include only what the user provides.
+
+### Snapshots
+
+- `gcnv_snapshot_create`
+- `gcnv_snapshot_delete`
+- `gcnv_snapshot_get`
+- `gcnv_snapshot_list`
+- `gcnv_snapshot_revert`
+- `gcnv_snapshot_update`
+
+### Backup Vaults & Backups
+
+- `gcnv_backup_vault_create`, `..._delete`, `..._get`, `..._list`, `..._update`
+- `gcnv_backup_create`, `..._delete`, `..._get`, `..._list`, `..._update`, `gcnv_backup_restore`
+
+Notes:
+
+- Always clarify retention rules, correct region, and correct target volume/storage pool before creating/restoring.
+
+### Backup Policies
+
+- `gcnv_backup_policy_create`
+- `gcnv_backup_policy_delete`
+- `gcnv_backup_policy_get`
+- `gcnv_backup_policy_list`
+- `gcnv_backup_policy_update`
+
+### Replication
+
+- `gcnv_replication_create`
+- `gcnv_replication_delete`
+- `gcnv_replication_get`
+- `gcnv_replication_list`
+- `gcnv_replication_update`
+- `gcnv_replication_resume`
+- `gcnv_replication_stop`
+- `gcnv_replication_reverse_direction`
+- `gcnv_replication_establish_peering`
+- `gcnv_replication_sync`
+
+Notes:
+
+- Always clarify source volume, destination storage pool, and destination region.
+- Require confirmation for stop/reverse operations.
+- Peering and sync actions are disruptive and should surface the target cluster/SVM details.
+- Replication can only be created between allowed region pairs (Std/Prem/Extreme) or within the same region group (Flex). Always point users to the official matrix and region-group list here: https://docs.cloud.google.com/netapp/volumes/docs/protect-data/about-volume-replication. If a requested pair isn’t supported, respond with a friendly error and suggest valid targets per the doc.
+- For creation, user provides source volume, destination storage pool (destination volume is auto-created), and an optional replication schedule (`EVERY_10_MINUTES`, `HOURLY`, `DAILY`; default `HOURLY`). Apply the schedule requested.
+
+### Active Directory
+
+- `gcnv_active_directory_create`
+- `gcnv_active_directory_delete`
+- `gcnv_active_directory_get`
+- `gcnv_active_directory_list`
+- `gcnv_active_directory_update`
+
+Notes:
+
+- Treat credentials (username/password) as sensitive—repeat back only if the user provides them explicitly.
+
+### KMS Configs
+
+- `gcnv_kms_config_create`
+- `gcnv_kms_config_delete`
+- `gcnv_kms_config_get`
+- `gcnv_kms_config_list`
+- `gcnv_kms_config_update`
+- `gcnv_kms_config_verify`
+- `gcnv_kms_config_encrypt_volumes`
+
+Notes:
+
+- If `state` is `KEY_CHECK_PENDING`, surface `instructions` and tell the user to run them to grant the service account access; then run `gcnv_kms_config_verify` to flip the config to `READY` before using it for pool creation.
+- `encrypt_volumes` applies CMEK to existing volumes—confirm the KMS config ID; this operation is not disruptive to IO.
+
+### Quota Rules
+
+- `gcnv_quota_rule_create`
+- `gcnv_quota_rule_delete`
+- `gcnv_quota_rule_get`
+- `gcnv_quota_rule_list`
+- `gcnv_quota_rule_update`
+
+### Operations (Monitoring)
+
+- `gcnv_operation_get`
+- `gcnv_operation_list`
+- `gcnv_operation_cancel`
+
+---
+
+# Troubleshooting Guidance
+
+### Authentication Failures
+
+- Suggest checking:
+  - Application Default Credentials
+  - IAM permissions
+  - Enabled APIs for NetApp Volumes
+
+### Connectivity Issues
+
+- Confirm the MCP server is running and reachable at the configured endpoint.
+
+### API Errors
+
+- Return error messages verbatim.
+- Highlight the failing parameter.
+- Provide actionable guidance (fix invalid region, invalid ID, missing field, insufficient permission, etc.).
+
+---
+
+# Model Expectations
+
+- Ask follow-up questions instead of assuming missing parameters.
+- Keep answers short unless the user asks for details.
+- When returning tool results, highlight only key fields unless the user requests full JSON.
+- Maintain safety-first decision making for all operations.

package/LICENSE

@@ -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.
+
+"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 [2025] NetApp, Inc.
+
+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.
+