Gbox

🚀 gbox 使用文档

gbox は、特定の機能を提供するツールで、Go や Docker などの技術を利用して構築されています。このドキュメントでは、gbox のインストール、使用方法、コントリビュート方法などについて説明します。

🚀 クイックスタート

gbox を使用するには、まずインストールとセットアップが必要です。以下の手順に従って進めてください。

📦 インストール

前提条件

• Go 1.21 以上のバージョン
• Docker Desktop
• Make ツール
• pnpm (corepack 経由)
• Node.js 16.13 以上のバージョン

ビルド

# すべてのコンポーネントをビルド
make build

# リリースパッケージを作成
make dist

サービスの起動

# API Server
make -C packages/api-server dev

# MCP Server
cd packages/mcp-server && pnpm dev

# MCP Inspector
cd packages/mcp-server && pnpm inspect

✨ コントリビュートガイド

私たちは皆さんのコントリビューションを歓迎します！自由に Pull Request を送信してください。大きな変更については、まず問題を開いて議論してください。

1. リポジトリをフォークする
2. 機能ブランチを作成する (git checkout -b username/feature-name)
3. 変更をコミットする (git commit -m 'Add some feature')
4. ブランチにプッシュする (git push origin username/feature-name)
5. Pull Request を開く

注意事項（開発とローカル環境のデバッグ）

システムにインストールされたバージョンではなく、開発環境で gbox を実行する方法

1. gbox cleanup を実行して、インストールされている gbox を停止し、API サーバーが開発環境で実行できるようにします。
2. プロジェクトのルートディレクトリで make api-dev を実行します。
3. ./gbox box list を実行します。これは開発環境から実行されるコマンドです。

MCP クライアント（Claude Desktop など）を開発環境の MCP サーバーに接続する方法

1. プロジェクトのルートディレクトリで make mcp-dev を実行します。
2. ./gbox mcp export --merge-to claude を実行します。

MCP 検査ウィンドウを開く方法

1. プロジェクトのルートディレクトリで make mcp-inspect を実行します。
2. ターミナルで返されたリンクをクリックします。

開発環境でイメージをビルドして使用する方法

1. プロジェクトのルートディレクトリで make build-image-python を実行して Python イメージをビルドするか、make build-images を実行してすべてのイメージをビルドします。
2. 必要に応じてイメージ名を変更します（たとえば、make build-image-typescript を実行して TypeScript イメージを取得します）。
3. 新しいイメージを有効にするために、現在のサンドボックスを削除する必要がある場合があります ./gbox box delete --all

MCP クライアントがまだ古い MCP 内容を表示するのはなぜですか？

1. MCP 設定を変更した場合（たとえば、ツール定義）、make build を実行して dist/index.js ファイルを更新する必要があります。
2. ./gbox mcp export --merge-to claude を実行する必要がある場合もあります。

📄 ライセンス

このプロジェクトは Apache License 2.0 の下でライセンスされています。詳細については、LICENSE ファイルを参照してください。