MCP Zero

🚀 Go-Zero MCP Tool

Go-Zero MCP Toolは、開発者が簡単にGo-Zeroプロジェクトのスキャフォールディングと生成を行うためのModel Context Protocol (MCP)ツールです。このツールを使用することで、REST APIサービスやgRPCサービスの生成、データベースモデルの作成など、様々な作業を迅速に行うことができます。

🚀 クイックスタート

mcp-zeroが初めての方は、クイックスタートガイドをご覧ください。このガイドでは、以下の内容が説明されています。

• インストールと設定
• 最初のAPIサービスの作成
• 一般的な使用例とワークフロー
• Claude Desktopとの統合

✨ 主な機能

コアサービス生成

• APIサービスの作成：カスタマイズ可能なポートとスタイルで新しいREST APIサービスを生成します。
• RPCサービスの作成：Protobuf定義からgRPCサービスを生成します。
• APIコードの生成：API仕様ファイルをGoコードに変換します。
• モデルの生成：様々なソース（MySQL、PostgreSQL、MongoDB、DDL）からデータベースモデルを作成します。
• API仕様の作成：サンプルAPI仕様ファイルを生成します。

高度な機能

• プロジェクトの分析：既存のGo-Zeroプロジェクトを分析し、構造と依存関係を理解します。
• 設定の管理：適切な構造検証を伴う設定ファイルを生成します。
• テンプレートの生成：ミドルウェア、エラーハンドラー、デプロイメントテンプレートを作成します。
• ドキュメントのクエリ：Go-Zeroの概念や他のフレームワークからの移行ガイドにアクセスします。
• 入力の検証：API仕様、Protobuf定義、設定ファイルの包括的な検証を行います。

📦 インストール

前提条件

1. Go (1.19以上)
2. go-zero CLI (goctl)：go install github.com/zeromicro/go-zero/tools/goctl@latest でインストールします。
3. Claude Desktop (または他のMCP互換クライアント)

詳細なインストール手順については、クイックスタートガイドを参照してください。

インストール手順

1. MCPツール用の新しいディレクトリを作成します。

   mkdir go-zero-mcp && cd go-zero-mcp
   

2. Goモジュールを初期化します。

   go mod init go-zero-mcp
   

3. 依存関係をインストールします。

   go get github.com/modelcontextprotocol/go-sdk
   go get gopkg.in/yaml.v3
   

4. メインツールのコードを main.go として保存します。

5. ツールをビルドします。

   go build -o go-zero-mcp main.go
   

Claude Desktopの設定

Claude DesktopのMCP設定に以下の設定を追加します。

macOS

~/Library/Application Support/Claude/claude_desktop_config.json を編集します。

{
  "mcpServers": {
    "mcp-zero": {
      "command": "/path/to/your/mcp-zero",
      "env": {
        "GOCTL_PATH": "/Users/yourname/go/bin/goctl"
      }
    }
  }
}

Linux

~/.config/Claude/claude_desktop_config.json を編集します。

{
  "mcpServers": {
    "mcp-zero": {
      "command": "/path/to/your/mcp-zero",
      "env": {
        "GOCTL_PATH": "/usr/local/bin/goctl"
      }
    }
  }
}

Windows

%APPDATA%\Claude\claude_desktop_config.json を編集します。

{
  "mcpServers": {
    "mcp-zero": {
      "command": "C:\\path\\to\\your\\mcp-zero.exe",
      "env": {
        "GOCTL_PATH": "C:\\Go\\bin\\goctl.exe"
      }
    }
  }
}

💻 使用例

新しいAPIサービスの作成

Please create a new go-zero API service called "user-service" on port 8080

RPCサービスの作成

Create a new go-zero RPC service called "auth-service" with this protobuf definition:

syntax = "proto3";

package auth;

option go_package = "./auth";

service AuthService {
  rpc Login(LoginRequest) returns (LoginResponse);
  rpc Logout(LogoutRequest) returns (LogoutResponse);
}

message LoginRequest {
  string username = 1;
  string password = 2;
}

message LoginResponse {
  string token = 1;
  int64 expires_at = 2;
}

message LogoutRequest {
  string token = 1;
}

message LogoutResponse {
  bool success = 1;
}

データベースからのモデル生成

Generate go-zero models from my MySQL database with connection string "user:password@tcp(localhost:3306)/mydb"

API仕様の作成

Create an API specification for a "blog-service" with these endpoints:
- GET /api/posts (handler: GetPostsHandler)
- POST /api/posts (handler: CreatePostHandler)
- GET /api/posts/:id (handler: GetPostHandler)
- PUT /api/posts/:id (handler: UpdatePostHandler)
- DELETE /api/posts/:id (handler: DeletePostHandler)

プロジェクトの分析

Analyze my go-zero project in /path/to/myproject to understand its structure

設定の生成

Generate a production configuration file for my "order-service" API service

テンプレートの生成

Generate a middleware template for my "auth-service"

ドキュメントのクエリ

How do I implement JWT authentication in go-zero?

How do I migrate from Express.js to go-zero?

入力の検証

Validate this API spec file at /path/to/service.api with strict mode enabled

プロジェクト構造

ビルド後のMCPサーバーは以下の構造になります。

mcp-zero/
├── main.go                    # エントリポイントとツール登録
├── tools/                     # ツールの実装
│   ├── create_api_service.go
│   ├── create_rpc_service.go
│   ├── generate_api.go
│   ├── generate_model.go
│   ├── create_api_spec.go
│   ├── analyze_project.go
│   ├── generate_config.go
│   ├── generate_template.go
│   ├── query_docs.go
│   └── validate_input.go
├── internal/                  # 内部パッケージ
│   ├── analyzer/             # プロジェクト分析
│   ├── validation/           # 入力検証
│   ├── security/             # 資格情報の取り扱い
│   ├── templates/            # コードテンプレート
│   ├── docs/                 # ドキュメントデータベース
│   ├── logging/              # 構造化ロギング
│   └── metrics/              # パフォーマンスメトリクス
└── tests/                     # テストスイート
    ├── integration/
    └── unit/

アーキテクチャ

MCPサーバーは以下の要素で構築されています。

• MCP SDK：プロトコルの実装に github.com/modelcontextprotocol/go-sdk を使用します。
• トランスポート：Claude Desktopとのstdioベースの通信を行います。
• コード生成：本番環境で使用可能なコードを生成するために、go-zeroのgoctl CLIツールを活用します。
• 検証：安全性と正確性のための包括的な入力検証を行います。
• セキュリティ：環境変数の置換による安全な資格情報の取り扱いを行います。
• 監視性：ツールのパフォーマンスを監視するための組み込みロギングとメトリクスが備わっています。

ベストプラクティス

1. サービス名：ハイフン付きの小文字を使用します（例："user-service", "auth-api"）。
2. ポート設定：各サービスに一意のポートを選択します（8080 - 8090の範囲が推奨されます）。
3. コードスタイル：公式の規約との一貫性を保つために、"go_zero" スタイルを使用します。
4. 設定：環境固有の設定ファイル（dev、test、prod）を使用します。
5. ドキュメント：Go-Zeroのベストプラクティスに沿った状態を維持するために、定期的にドキュメントを参照します。
6. 検証：エラーを早期に発見するために、生成前に常に入力を検証します。

トラブルシューティング

一般的な問題

1. goctlコマンドが見つからない：goctlがインストールされており、PATHに含まれていることを確認してください。
2. 権限が拒否された：MCPツールの実行ファイルに適切な権限が付与されていることを確認してください。
3. データベース接続エラー：接続文字列とデータベースのアクセシビリティを確認してください。

デバッグモード

デバッグロギングを有効にするには、以下の環境変数を設定します。

export MCP_DEBUG=1

貢献

このツールを以下のような追加のGo-Zero機能で拡張することができます。

• Dockerfileの生成
• Kubernetesマニフェストの生成
• Docker Composeファイルの作成
• APIドキュメントの生成
• テストテンプレートの作成

📄 ライセンス

MITライセンス - 詳細については LICENSE ファイルを参照してください。

Copyright (c) 2025 go-zeroチーム