@gmo-internet/conoha-vps-mcp 0.3.0

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
+      (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 2025 GMO Internet
+
+   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/NOTICE

@@ -0,0 +1,116 @@
+ConoHa VPS MCP
+Copyright 2024 GMO Internet
+
+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.
+
+This product includes software developed by third parties:
+
+
+BSD-2-Clause Licensed:
+  - uri-js (4.4.1)
+
+BSD-3-Clause Licensed:
+  - qs (6.14.0)
+
+ISC Licensed:
+  - inherits (2.0.4)
+  - isexe (2.0.0)
+  - once (1.4.0)
+  - setprototypeof (1.2.0)
+  - which (2.0.2)
+  - wrappy (1.0.2)
+  - zod-to-json-schema (3.24.6)
+
+MIT Licensed:
+  - @modelcontextprotocol/sdk (1.18.1)
+  - accepts (2.0.0)
+  - ajv (6.12.6)
+  - body-parser (2.2.0)
+  - bytes (3.1.2)
+  - call-bind-apply-helpers (1.0.2)
+  - call-bound (1.0.4)
+  - content-disposition (1.0.0)
+  - content-type (1.0.5)
+  - cookie (0.7.2)
+  - cookie-signature (1.2.2)
+  - cors (2.8.5)
+  - cross-spawn (7.0.6)
+  - debug (4.4.3)
+  - depd (2.0.0)
+  - dunder-proto (1.0.1)
+  - ee-first (1.1.1)
+  - encodeurl (2.0.0)
+  - es-define-property (1.0.1)
+  - es-errors (1.3.0)
+  - es-object-atoms (1.1.1)
+  - escape-html (1.0.3)
+  - etag (1.8.1)
+  - eventsource (3.0.7)
+  - eventsource-parser (3.0.6)
+  - express (5.1.0)
+  - express-rate-limit (7.5.1)
+  - fast-deep-equal (3.1.3)
+  - fast-json-stable-stringify (2.1.0)
+  - finalhandler (2.1.0)
+  - forwarded (0.2.0)
+  - fresh (2.0.0)
+  - function-bind (1.1.2)
+  - get-intrinsic (1.3.0)
+  - get-proto (1.0.1)
+  - gopd (1.2.0)
+  - has-symbols (1.1.0)
+  - hasown (2.0.2)
+  - http-errors (2.0.0)
+  - http-errors (2.0.1)
+  - iconv-lite (0.6.3)
+  - ipaddr.js (1.9.1)
+  - is-promise (4.0.0)
+  - json-schema-traverse (0.4.1)
+  - math-intrinsics (1.1.0)
+  - media-typer (1.1.0)
+  - merge-descriptors (2.0.0)
+  - mime-db (1.54.0)
+  - mime-types (3.0.1)
+  - ms (2.1.3)
+  - negotiator (1.0.0)
+  - object-assign (4.1.1)
+  - object-inspect (1.13.4)
+  - on-finished (2.4.1)
+  - parseurl (1.3.3)
+  - path-key (3.1.1)
+  - path-to-regexp (8.3.0)
+  - pkce-challenge (5.0.0)
+  - proxy-addr (2.0.7)
+  - punycode (2.3.1)
+  - range-parser (1.2.1)
+  - raw-body (0.7.0)
+  - raw-body (3.0.1)
+  - router (2.2.0)
+  - safe-buffer (5.2.1)
+  - safer-buffer (2.1.2)
+  - send (1.2.0)
+  - serve-static (2.2.0)
+  - shebang-command (2.0.0)
+  - shebang-regex (3.0.0)
+  - side-channel (1.1.0)
+  - side-channel-list (1.0.0)
+  - side-channel-map (1.0.1)
+  - side-channel-weakmap (1.0.2)
+  - statuses (2.0.2)
+  - toidentifier (1.0.1)
+  - type-is (2.0.1)
+  - unpipe (1.0.0)
+  - vary (1.1.2)
+  - zod (3.25.76)
+
+For the full license text of these dependencies, please refer to their respective repositories or the node_modules directory.

package/README.md

@@ -0,0 +1,249 @@
+<div align="center">
+
+![ConoHa VPS Logo](assets/conoha_logo.svg)
+
+# ConoHa VPS MCP Server
+
+**日本語対応のConoHa VPS Model Context Protocol (MCP) サーバー**
+
+[![GitHub Stars](https://img.shields.io/github/stars/gmo-internet/conoha_vps_mcp?style=flat-square&logo=github)](https://github.com/gmo-internet/conoha_vps_mcp/stargazers)
+[![GitHub License](https://img.shields.io/github/license/gmo-internet/conoha_vps_mcp?style=flat-square)](LICENSE)
+[![GitHub Release](https://img.shields.io/github/v/release/gmo-internet/conoha_vps_mcp?style=flat-square)](https://github.com/gmo-internet/conoha_vps_mcp/releases)
+
+[![Node.js](https://img.shields.io/badge/Node.js-18+-green?style=flat-square&logo=node.js)](https://nodejs.org/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-white?style=flat-square&logo=typescript)](https://www.typescriptlang.org/)
+[![Docker](https://img.shields.io/badge/Docker-white?style=flat-square&logo=docker)](https://www.docker.com/)
+[![OpenStack](https://img.shields.io/badge/OpenStack-API-red?style=flat-square&logo=openstack)](https://docs.openstack.org/)
+
+[🚀 クイックスタート](#-クイックスタート) • [📚 使用例](#-使用例) • [よくある質問（FAQ）](docs/FAQ.md)
+
+</div>
+
+---
+
+## 🌟 概要
+
+> [!IMPORTANT]
+> v0.3.0 以降、本パッケージの配布元を GitHub Packages から npm レジストリへ移行しました。
+> 最新バージョンは npm から入手してください。
+
+ConoHa VPS MCPは、ConoHa VPSの[公開API](https://doc.conoha.jp/reference/api-vps3/)を**日本語**で簡単に操作できるオープンソースの**Model Context Protocol (MCP) サーバー**です。
+
+Claude、GitHub Copilot、ClineなどのAIエージェントと連携することで、**自然言語によるインフラ操作**が可能になります。
+
+> [!CAUTION]
+> **⚠️ 本ソフトウェアは現在ベータ版です**
+>
+> - いかなる保証もなく現状のまま提供されます。
+> - 機能・動作は予告なく変更される場合があります。
+> - 本番環境での使用前に十分なテストを行ってください。
+> - バグやフィードバックは GitHub Issues からご報告願います。
+>
+> このベータ版 ConoHa VPS MCP を使用することで、これらの条件に同意したものとみなされます。
+
+## ✨ 主な特徴
+
+| 特徴 | 説明 |
+|------|------|
+| 🇯🇵 **完全日本語対応** | 完全日本語対応 「ConoHa VPS」のリソースを、日本語で直感的な操作が可能 |
+| 🤖 **AI エージェントとの連携** | GitHub Copilot や Claude など、主要な AI エージェントと連携し、操作や構成の提案をサポート |
+| 🔧 **包括的API** | サーバー・ボリューム・イメージ・セキュリティグループ管理をサポート |
+| 🐳 **クロスプラットフォーム** | Node.js および Dockerでの実行環境を提供 |
+| 🛡️ **セキュリティ対策** | OpenStack 準拠のセキュリティ機能を装備 |
+
+## ❓ Model Context Protocol (MCP) とは
+
+Model Context Protocolとは、GitHub Copilot、Cline、ClaudeなどのAIエージェントがインターネット上のサービスや様々なツールと連携するための共通化された仕組み（プロトコル）です。
+この仕組みにより、AIエージェントがあなたの代わりに、サーバーの操作やファイルの管理などの複雑な作業を簡単かつ自動で行えるようになります。
+
+## 🚀 クイックスタート
+
+### Claude Desktopで利用する場合
+
+1. [Releases](https://github.com/gmo-internet/conoha_vps_mcp/releases/)よりダウンロードしたmcpbファイルをClaude Desktopに登録
+2. Claude Desktopで環境変数を設定
+
+詳細な手順は 👉 [mcpb ファイルインストール版実行ガイド](docs/mcpb-setup.md) を参照してください。
+
+### それ以外のAIエージェント (GitHub Copilot等) で利用する場合
+
+1. Node.jsをローカル端末にインストール
+2. 利用中のMCP対応のAIエージェントにConoHa VPS MCPの設定を記載し、MCPサーバーを起動
+    <details>
+    <summary>設定（簡略版）</summary>
+
+    ```json
+    {
+      "ConoHa VPS MCP": {
+        "command": "npm",
+        "args": [
+          "exec",
+          "@gmo-internet/conoha-vps-mcp@latest"
+        ],
+        "env": {
+          "OPENSTACK_TENANT_ID": "YOUR_OPENSTACK_TENANT_ID",
+          "OPENSTACK_USER_ID": "YOUR_OPENSTACK_USER_ID",
+          "OPENSTACK_PASSWORD": "YOUR_OPENSTACK_PASSWORD"
+        }
+      }
+    }
+    ```
+    </details>
+
+詳細な手順は 👉 [npm パッケージインストール版実行ガイド](docs/npm-setup.md) を参照してください。
+
+### 🔧 その他の方法で利用する場合
+
+- 📋 [Node.js ローカルビルド版実行ガイド](docs/nodejs-setup.md) - ソースコードからビルドして実行
+- 🐳 [Docker ローカルビルド版実行ガイド](docs/docker-setup.md) - Dockerコンテナで実行
+
+🆘 トラブルシューティング
+
+- ❓ [FAQ](docs/FAQ.md) - よくある質問と解決方法
+
+## 🎯 使用例
+
+### リソース管理
+
+```txt
+現在あるサーバーの一覧を表示してください。
+```
+
+```txt
+現在あるサーバーを確認し、test-1という名前のサーバーを停止してください。
+```
+
+```txt
+test-1という名前のサーバーにアタッチされているボリュームの詳細を表示してください。
+```
+
+### サーバー作成
+
+```txt
+サーバープラン一覧、イメージ一覧、ボリュームタイプ一覧を確認して、
+Ubuntu 24.04でメモリ1GBのサーバーを、rootパスワード：vG7#kLp9zX!q、
+ネームタグ：test-1、セキュリティグループ：defaultとして作ってください。
+```
+
+> [!CAUTION]
+> **パスワードセキュリティに関する重要な警告**
+>
+> - 上記のパスワード例は**絶対に実際に使用しないでください**（公開されているため）
+> - 実際の運用では、十分に複雑で一意なパスワードを生成してください
+> - サーバー作成後は、**直ちに**パスワードの変更、またはパスワード認証の無効化を行ってください
+> - SSHキー認証への変更を強く推奨します
+> - AIエージェントとの会話履歴にパスワードが残ることに注意してください
+
+### セキュリティ設定
+
+```txt
+Webサーバー用のセキュリティグループをweb-server-secgroupという名前で新しく作成して、
+HTTP（80番）とHTTPS（443番）のみを許可してください。
+```
+
+## 📚 ドキュメント
+
+### 対応プラットフォーム
+
+> [!IMPORTANT]
+> 今後のバージョンアップによってサポート対象外となる可能性があります。
+
+#### MCPサーバー実行環境
+
+- ✅ Node.js v18以上
+- ✅ Docker
+- ✅ Linux / macOS / Windows
+
+#### AIエージェント統合
+
+- ✅ [Claude Desktop](https://claude.ai/download)
+- ✅ [Cline (VS Code)](https://github.com/cline/cline)
+- ✅ [GitHub Copilot (VS Code)](https://docs.github.com/ja/copilot)
+
+> [!NOTE]
+> MCPに対応した他のAIエージェントでも利用できます。
+> 詳細は各AIエージェントのドキュメントを参照して下さい。
+
+#### ConoHa環境
+
+- ✅ ConoHa VPS v3.0 API
+
+### MCPサーバーで対応している主な機能一覧
+
+| カテゴリ | 主な対応機能 |
+|---------|-------------|
+| サーバー | 作成 / 削除 / 起動 / 停止 / リサイズ / コンソール接続 |
+| ボリューム | 作成 / 削除 / 更新 |
+| イメージ | 一覧取得 |
+| SSHキーペア | 作成 / 削除 |
+| セキュリティグループ | 作成 / 削除 / 更新 |
+| セキュリティグループルール | 作成 / 削除 |
+
+📄 ツールごとの全機能一覧は[こちら](docs/tool.md)を参照してください。
+
+## ⚠️ 重要な注意事項
+
+### AIエージェント利用について
+
+- Claude等、AIエージェントの利用には別途費用が発生する場合があります
+- 利用しているAIエージェントの料金プランや課金形態は十分確認してください
+
+### API利用について
+
+- 🔑 **認証**: ConoHa VPSの公開APIクレデンシャルが必要です
+- 💰 **課金**: MCP自体は無償ですが、VPS作成等の操作により料金が発生する場合があります
+- 🛠️ **サポート**: MCP利用はConoHaサポート対象外です
+
+### 自動化利用について
+
+- 設定ミスにより意図しない課金が発生する可能性があります
+- 自動化する際は設定の確認とセキュリティ対策を十分に行ってください
+- 不安な場合はコントロールパネルからの手動操作を推奨します
+
+### セキュリティ考慮事項
+
+- 🔐 APIクレデンシャルを安全に管理してください
+- 🚫 本番環境では自動化スクリプトの十分な検証を行ってください
+- 📊 使用状況を定期的に監視してください
+
+詳細は[ConoHa APIご利用前の留意事項](https://doc.conoha.jp/reference/api-vps3/api-guideline-vps3/api-guideline-v3/)をご確認ください。
+
+## 🤝 コントリビュート
+
+私たちはコミュニティからの貢献を歓迎します！
+
+- 📝 [コントリビューションガイド](CONTRIBUTING.md)
+- 🤝 [行動規範](CODE_OF_CONDUCT.md)
+- 🔒 [セキュリティポリシー](SECURITY.md)
+
+バグ報告や機能要望は[GitHub Issues](https://github.com/gmo-internet/conoha_vps_mcp/issues)でお受けしています。
+
+## 📄 ライセンス
+
+このプロジェクトは[Apache License 2.0](LICENSE) の下で公開されています。
+
+## 🙏 謝辞
+
+- [Model Context Protocol](https://modelcontextprotocol.io/) - MCP仕様の開発
+- [OpenStack](https://www.openstack.org/) - クラウドインフラ技術の基盤
+
+## 📞 サポート・コミュニティ
+
+- 🐛 **バグ報告・機能要望**: [GitHub Issues](https://github.com/gmo-internet/conoha_vps_mcp/issues)
+- 🌟 **Star**: このプロジェクトが役に立ったら ⭐ をお願いします！
+
+## 🔗 関連リンク
+
+- [ConoHa 公式サイト](https://www.conoha.jp/)
+- [公開 API ドキュメント](https://doc.conoha.jp/reference/api-vps3/)
+- [Model Context Protocol 仕様](https://modelcontextprotocol.io/)
+
+---
+
+<div align="center">
+
+**Made by [GMO Internet](https://internet.gmo/)**
+
+[⬆️ トップに戻る](#conoha-vps-mcp-server)
+
+</div>