Gbox

🚀 gbox 使用文檔

gbox 是一個功能強大的工具，提供了一系列實用的功能和服務。本使用文檔將詳細介紹 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

✨ 主要特性

gbox 支持多組件構建與運行，涵蓋 API Server、MCP Server 等，同時提供了豐富的開發與調試功能，方便開發者在本地環境進行開發和測試。

💻 使用示例

基礎用法

按照上述安裝指南完成安裝和配置後，你就可以使用 gbox 的基本功能。例如，查看沙箱列表：

./gbox box list

高級用法

如何在開發環境中運行 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

📚 詳細文檔

貢獻指南

我們歡迎您的貢獻！請隨時提交 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

注意事項（開發和調試本地環境）

在開發和調試本地環境時，你可以參考上述使用示例中的高級用法部分，按照相應步驟進行操作。

📄 許可證

本項目根據 Apache License 2.0 許可，具體請查看 LICENSE 文件以獲取詳細信息。