メインコンテンツまでスキップ

ローカル開発環境セットアップガイド

このドキュメントでは、すべての必要なサービスコンポーネントを含む、完全なMCP Gateway開発環境をローカルにセットアップして起動する方法について説明します。

前提条件​

開始する前に、システムに以下のソフトウェアがインストールされていることを確認してください：

  • Git
  • Go 1.24.1以上
  • Node.js v20.18.0以上
  • npm

プロジェクトアーキテクチャの概要​

MCP Gatewayプロジェクトは、以下の主要コンポーネントで構成されています：

  1. apiserver - 設定管理、ユーザーインターフェース、その他のAPIサービスを提供
  2. mcp-gateway - コアゲートウェイサービス、MCPプロトコル変換を処理
  3. mock-user-svc - 開発テスト用のユーザーサービスをシミュレート
  4. web - 管理インターフェースフロントエンド

開発環境の起動​

1. プロジェクトのクローン​

MCP Gatewayコードリポジトリにアクセスし、Forkボタンをクリックして、プロジェクトをあなたのGitHubアカウントにフォークします。

2. ローカルにクローン​

フォークしたリポジトリをローカルにクローンします：

git clone https://github.com/あなたのgithubユーザー名/mcp-gateway.git

3. 環境依存関係の初期化​

プロジェクトディレクトリに入ります：

cd mcp-gateway

依存関係をインストールします：

go mod tidy
cd web
npm i

4. 開発環境の起動​

cp .env.example .env
cd web
cp .env.example .env

注意：何も変更せずにデフォルト設定で開発を開始できますが、Disk、DBなどの切り替えなど、あなたの環境や開発ニーズに合わせて設定ファイルを変更することもできます。

注意：すべてのサービスを実行するには、4つのターミナルウィンドウが必要になる場合があります。ホストマシン上で複数のサービスを実行するこの方法は、開発中の再起動やデバッグを容易にします。

4.1 mcp-gatewayの起動​

go run cmd/gateway/main.go

mcp-gatewayはデフォルトで http://localhost:5235 で起動し、MCPプロトコルリクエストを処理します。

4.2 apiserverの起動​

go run cmd/apiserver/main.go

apiserverはデフォルトで http://localhost:5234 で起動します。

4.3 mock-user-svcの起動​

go run cmd/mock-user-svc/main.go

mock-user-svcはデフォルトで http://localhost:5235 で起動します。

4.4 Webフロントエンドの起動​

npm run dev

Webフロントエンドはデフォルトで http://localhost:5236 で起動します。

これでブラウザで http://localhost:5236 にアクセスして管理インターフェースを使用できます。デフォルトのユーザー名とパスワードは環境変数（ルートディレクトリの.envファイル）によって決定され、具体的にはSUPER_ADMIN_USERNAMEとSUPER_ADMIN_PASSWORDです。ログイン後、管理インターフェースでユーザー名とパスワードを変更できます。

よくある問題​

環境変数の設定​

一部のサービスは、正常に動作するために特定の環境変数が必要な場合があります。.envファイルを作成するか、コマンドを開始する前にこれらの変数を設定できます：

# 例
export OPENAI_API_KEY="あなたのapi_key"
export OPENAI_MODEL="gpt-4o-mini"
export APISERVER_JWT_SECRET_KEY="あなたのシークレットキー"

次のステップ​

ローカル開発環境を正常に起動した後、以下のことができます：