Rule-MCP-Server by AkitoSakurabaCreator - MCP Server

Rule MCP Server

AIエージェント（Cursor、Claude Code、Cline）が共通のルールを取得・適用できるMCP（Model Context Protocol）サーバーです。

機能

プロジェクトごとのルール管理
言語別のグローバルルール管理
プロジェクトごとのグローバルルール適用設定
コードのルール違反検証
MCP経由でのルール配布
RESTful API エンドポイント
ReactベースのWeb UIによるルール管理
多言語対応（i18n）: 英語、日本語、中国語、ヒンディー語、スペイン語、アラビア語
ダークテーマ対応: ライト/ダークモード切り替え
Grafana監視ダッシュボード: システムメトリクス、MCPリクエスト監視、アラート機能
クリーンアーキテクチャによる保守性の高い設計

🚀 クイックスタート

パターン1: 既にサーバーが動いている場合

Rule MCP Serverが既に稼働している場合は、以下の手順でAIエージェントを設定するだけです。

1. MCPサーバーのインストール

# pnpm dlx経由（推奨・インストール不要）
pnpm dlx rule-mcp-server

# またはグローバルインストール
pnpm add -g rule-mcp-server

2. AIエージェント設定

Cursor

# 設定テンプレートをコピー
cp config/pnpm-mcp-config.template.json ~/.cursor/mcp.json

Claude Code

# Claude Code にMCPサーバーを追加（stdio）
claude mcp add rule-mcp-server --env RULE_SERVER_URL=http://localhost:18080 -- pnpm dlx rule-mcp-server

# APIキーを使う場合
claude mcp add rule-mcp-server \
  --env RULE_SERVER_URL=http://localhost:18080 \
  --env MCP_API_KEY=your_api_key \
  -- pnpm dlx rule-mcp-server

# 参考: Anthropic公式ドキュメント
# https://docs.anthropic.com/ja/docs/claude-code/mcp

3. 利用開始！

AIエージェント（Cursor/Claude Code）を再起動して、コーディングルールを自動取得・適用できるようになります。

📦 npmパッケージ: rule-mcp-server

パターン2: サーバーを自分で立ち上げる場合

Rule MCP Serverを自分で立ち上げて運用したい場合は、以下の手順に従ってください。本番環境での運用を推奨します。

1. 環境設定

# 本番環境用の環境変数ファイルを作成
cp env.production.example .env.production

# .env.productionファイルを編集（必要に応じて）
nano .env.production

本番環境での必須設定:

JWT_SECRET: 強力なランダム文字列（生成方法は後述）
ALLOWED_ORIGINS: 許可するオリジンをカンマ区切りで指定
ENV=production: 本番環境モードに設定

秘密鍵の生成方法:

# OpenSSLを使用
openssl rand -hex 32

# Pythonを使用
python3 -c "import secrets; print(secrets.token_hex(32))"

# Node.jsを使用
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

2. サーバー起動

本番環境での起動（推奨）

# 本番環境用Docker Composeで起動
docker compose -f docker-compose.prod.yml up -d

# 稼働確認
curl http://localhost:18080/api/v1/health
# -> {"status":"ok"} が返れば稼働中

本番環境のアクセス:

Web UI: http://localhost:18000
API: http://localhost:18000/api/v1
データベース: localhost:15432

開発環境での起動（開発者向け）

# 開発環境用の環境変数ファイルを作成
cp env.development.example .env.development

# 開発環境用Docker Composeで起動
docker compose -f docker-compose.dev.yml up -d

# 稼働確認
curl http://localhost:18080/api/v1/health
# -> {"status":"ok"} が返れば稼働中

開発環境のアクセス:

Web UI: http://localhost:18000
API: http://localhost:18000/api/v1
データベース: localhost:15432

チーム運用での起動

# 本番環境で起動（チーム共有用）
docker compose -f docker-compose.prod.yml up -d

# 稼働確認
curl http://localhost:18080/api/v1/health
# -> {"status":"ok"} が返れば稼働中

チーム運用のアクセス:

Web UI: http://[サーバーIP]:13000
API: http://[サーバーIP]:18080/api/v1
データベース: [サーバーIP]:15432

LAN 内公開の例（チーム運用）

サーバーをLAN上のホストで起動し、クライアント側の環境変数をLAN IPに設定:

{
  "mcpServers": {
    "rule-mcp-server": {
      "env": {
        "RULE_SERVER_URL": "http://192.168.1.20:18080",
        "MCP_API_KEY": "${MCP_API_KEY:-}"
      }
    }
  }
}

参考: Makefile を使う場合は make docker-up / make docker-down

技術スタック

バックエンド

Go 1.21+ + Gin Web Framework
クリーンアーキテクチャ（Domain, Usecase, Interface, Infrastructure）
PostgreSQL データベース
MCP（Model Context Protocol） サポート

フロントエンド

React 18 + TypeScript
Material-UI (MUI) コンポーネントライブラリ
React Router によるルーティング
i18next による多言語対応
Axios によるAPI通信

セットアップ

前提条件

Go 1.21以上がインストールされていること
Node.js 18以上がインストールされていること
Docker と Docker Compose がインストールされていること
PostgreSQL 15以上（Docker使用時は自動でインストール）

初期管理アカウント

システム初回起動時に以下の初期管理アカウントが自動的に作成されます：

ユーザー名: admin
パスワード: admin123
メール: admin@rulemcp.com
権限: 管理者（admin）

重要: 初回ログイン後は必ずパスワードを変更してください。

開発者向けセットアップ

git clone <repository-url>
cd Rule-MCP-Server

# 環境変数ファイルをコピー
cp env.template .env.production

# バックエンド依存関係
go mod tidy

# フロントエンド依存関係
cd frontend
npm install
cd ..

起動方法

本番環境（推奨）

# 本番環境用Docker Composeで起動
docker compose -f docker-compose.prod.yml up -d

# 停止
docker compose -f docker-compose.prod.yml down

開発環境

# 開発環境用Docker Composeで起動
docker compose -f docker-compose.dev.yml up -d

# 停止
docker compose -f docker-compose.dev.yml down

ローカル開発（Docker不使用）

# バックエンド（ポート18080）
go run ./cmd/server

# フロントエンド（別ターミナル）
cd frontend
npm start

アーキテクチャ

クリーンアーキテクチャ

cmd/server/          # エントリーポイント
├── internal/
│   ├── domain/      # エンティティ、リポジトリインターフェース
│   ├── usecase/     # ビジネスロジック
│   ├── interface/   # HTTPハンドラー、MCPハンドラー
│   └── infrastructure/ # データベース実装
└── frontend/        # Reactフロントエンド

レイヤー構成

Domain Layer: ビジネスエンティティとルール
Usecase Layer: アプリケーションのビジネスロジック
Interface Layer: HTTP API、MCPプロトコル
Infrastructure Layer: PostgreSQL、ファイルシステム

API エンドポイント

ヘルスチェック

GET /api/v1/health

ルール取得

GET /api/v1/rules?project={project_id}

コード検証

POST /api/v1/rules/validate
Content-Type: application/json

{
  "project_id": "web-app",
  "code": "console.log('test')"
}

プロジェクト管理

# プロジェクト一覧取得
GET /api/v1/projects

# プロジェクト作成
POST /api/v1/projects
Content-Type: application/json

{
  "project_id": "new-project",
  "name": "New Project",
  "description": "A new project description",
  "language": "javascript",
  "apply_global_rules": true
}

ルール管理

# ルール作成
POST /api/v1/rules
Content-Type: application/json

{
  "project_id": "new-project",
  "rule_id": "no-debug-code",
  "name": "No Debug Code",
  "description": "Debug code should not be in production",
  "type": "style",
  "severity": "warning",
  "pattern": "debugger",
  "message": "Debug code detected. Remove before production."
}

# ルール削除
DELETE /api/v1/rules/{project_id}/{rule_id}

グローバルルール管理

# 言語別グローバルルール取得
GET /api/v1/global-rules/{language}

# グローバルルール作成
POST /api/v1/global-rules
Content-Type: application/json

{
  "language": "javascript",
  "rule_id": "no-console-log",
  "name": "No Console Log",
  "description": "Console.log statements should not be in production code",
  "type": "style",
  "severity": "warning",
  "pattern": "console.log",
  "message": "Console.log detected. Use proper logging framework in production."
}

# グローバルルール削除
DELETE /api/v1/global-rules/{language}/{rule_id}

# 利用可能な言語一覧取得
GET /api/v1/languages

MCP（Model Context Protocol）Server

このサーバーはMCPサーバーとして動作し、CursorやClineから直接ルールを取得できます。

MCP エンドポイント

POST /mcp/request    # HTTP MCPリクエスト
GET  /mcp/ws         # WebSocket MCP接続

MCP メソッド

getRules: プロジェクトのルールを取得
validateCode: コードのルール違反を検証
getProjectInfo: プロジェクト情報を取得

標準的なMCPサーバー設定（推奨）

このプロジェクトは標準的なMCP（Model Context Protocol）サーバーを提供します。

特徴

✅ 標準MCP SDK使用: @modelcontextprotocol/sdkによる完全準拠
✅ StdioServerTransport: 標準的なMCPクライアントと互換
✅ pnpmパッケージ対応: pnpm dlxで簡単インストール
✅ Docker対応: 本番環境での安定動作
✅ テンプレート設定: 簡単セットアップ

1. MCPサーバーのインストール

pnpm経由（推奨）

# グローバルインストール
pnpm add -g rule-mcp-server

# またはpnpm dlx経由（インストール不要）
pnpm dlx rule-mcp-server

📦 npmパッケージ: rule-mcp-server として公開済み

開発版ビルド

# 依存関係のインストール
make install-mcp

# MCPサーバーのビルド
make build-mcp

2. 環境別設定

pnpmパッケージ使用（推奨）

# pnpmパッケージ用設定テンプレートを使用
cp config/pnpm-mcp-config.template.json ~/.cursor/mcp.json

設定例（pnpmパッケージ）:

{
  "mcpServers": {
    "rule-mcp-server": {
      "command": "pnpm",
      "args": ["dlx", "rule-mcp-server"],
      "env": {
        "RULE_SERVER_URL": "http://localhost:18080",
        "MCP_API_KEY": ""
      },
      "description": "Standard MCP Server for Rule Management",
      "disabled": false,
      "autoApprove": []
    }
  }
}

Docker環境

# Docker環境を起動
make docker-up

# Docker用設定テンプレートを使用
cp config/docker-mcp-config.template.json ~/.cursor/mcp_settings.json

設定例（Docker環境）:

{
  "mcpServers": {
    "rule-mcp-server": {
      "command": "node",
      "args": ["/path/to/your/RuleMCPServer/cmd/mcp-server/build/index.js"],
      "env": {
        "RULE_SERVER_URL": "http://localhost:18080",
        "MCP_API_KEY": ""
      },
      "description": "Standard MCP Server for Rule Management (Docker)",
      "disabled": false,
      "autoApprove": []
    }
  }
}

開発環境

# 開発サーバーを起動
make run

# 標準設定テンプレートを使用
cp config/standard-mcp-config.template.json ~/.cursor/mcp_settings.json

設定例（開発環境）:

{
  "mcpServers": {
    "rule-mcp-server": {
      "command": "node",
      "args": ["/path/to/your/RuleMCPServer/cmd/mcp-server/build/index.js"],
      "env": {
        "RULE_SERVER_URL": "http://localhost:18081",
        "MCP_API_KEY": ""
      },
      "description": "Standard MCP Server for Rule Management (Development)",
      "disabled": false,
      "autoApprove": []
    }
  }
}

3. 設定ファイルの配置

Cursor: ~/.cursor/mcp_settings.json
Cline: ~/.cline/mcp_settings.json
Claude Code: CLIで追加（claude mcp add ... を使用）

4. 利用可能なツール

標準MCPサーバーは以下のツールを提供：

ツール名	説明	必須パラメータ
`getRules`	プロジェクトルール取得	`project_id`
`validateCode`	コード検証	`project_id`, `code`
`getProjectInfo`	プロジェクト情報取得	`project_id`
`autoDetectProject`	プロジェクト自動検出	`path`
`scanLocalProjects`	ローカルプロジェクトスキャン	`base_path` (optional)
`getGlobalRules`	グローバルルール取得	`language`

5. 利用可能なリソース

標準MCPサーバーは以下のリソースを提供：

リソースURI	説明
`rule://projects/list`	プロジェクト一覧
`rule://{project_id}/rules`	プロジェクト固有ルール
`rule://{project_id}/info`	プロジェクト情報
`rule://global-rules/{language}`	言語別グローバルルール

従来のHTTP設定（互換性）

従来のHTTP APIを使用する場合：

{
  "mcpServers": {
    "rule-mcp-server": {
      "command": "curl",
      "args": [
        "-X", "POST",
        "-H", "Content-Type: application/json",
        "-d", "{\"id\":\"${requestId}\",\"method\":\"${method}\",\"params\":${params}}",
        "http://localhost:18081/mcp/request"
      ],
      "env": {
        "MCP_SERVER_URL": "http://localhost:18081"
      },
      "description": "Rule MCP Server for AI agents to retrieve and apply common rules"
    }
  }
}

MCP（Model Context Protocol）機能

基本機能

getRules: プロジェクトIDとオプションの言語を指定してルールを取得
validateCode: コードのルール違反を検証
getProjectInfo: プロジェクト情報を取得

プロジェクト自動検出機能 🆕

AIエージェントが自動的にプロジェクトを認識し、適切なルールを取得できる高度な機能です。

自動検出の優先順位

ディレクトリ名ベース検出（信頼度95%）
- ディレクトリ名をプロジェクトIDとして検索
- 除外ディレクトリ: node_modules, vendor, dist, build, target, .git, .vscode
Gitリポジトリ名検出（信頼度90%）
- .git/configからorigin URLを解析
- SSH形式: git@github.com:username/repo-name.git
- HTTPS形式: https://github.com/username/repo-name.git
言語固有ファイル検出（信頼度85%）
- go.mod → Goプロジェクト
- package.json → Node.jsプロジェクト
- requirements.txt → Pythonプロジェクト
- pom.xml → Javaプロジェクト
- Cargo.toml → Rustプロジェクト
- composer.json → PHPプロジェクト
- Gemfile → Rubyプロジェクト
デフォルトプロジェクト（信頼度70%）
- 検出できない場合のフォールバック

新しいMCPメソッド

`autoDetectProject`

指定されたパスからプロジェクトを自動検出します。

{
  "id": "auto-detect",
  "method": "autoDetectProject",
  "params": {
    "path": "/path/to/your/project"
  }
}

レスポンス例:

{
  "id": "auto-detect",
  "result": {
    "project": {
      "project_id": "web-app",
      "name": "Web Application",
      "language": "javascript"
    },
    "rules": [...],
    "detection_method": "directory_name",
    "confidence": 0.95,
    "message": "ディレクトリ名 'web-app' からプロジェクトを検出しました"
  }
}

`scanLocalProjects`

ローカルディレクトリを再帰的にスキャンしてプロジェクトを検出します。

{
  "id": "scan-local",
  "method": "scanLocalProjects",
  "params": {
    "base_path": "/home/user/projects"
  }
}

レスポンス例:

{
  "id": "scan-local",
  "result": {
    "projects": [
      {
        "project": {...},
        "rules": [...],
        "detection_method": "git_repository",
        "confidence": 0.90,
        "message": "Gitリポジトリ名からプロジェクトを検出しました"
      }
    ],
    "count": 3
  }
}

使用例

Cursor/Clineでの設定

1. cursor-mcp-config.json（推奨）

{
  "mcpServers": {
    "rule-mcp": {
      "command": "go",
      "args": ["run", "./cmd/server"],
      "env": {
        "PORT": "18081",
        "DB_HOST": "localhost",
        "DB_PORT": "15432",
        "DB_USER": "rule_mcp_user",
        "DB_PASSWORD": "rule_mcp_password",
        "DB_NAME": "rule_mcp_db"
      }
    }
  }
}

ファイル配置場所:

Cursor: ~/.cursor/mcp-servers/rule-mcp.json
Cline: ~/.cline/mcp-servers/rule-mcp.json

2. mcp-client-config.json（完全版）

{
  "mcpServers": {
    "rule-mcp": {
      "command": "go",
      "args": ["run", "./cmd/server"],
      "env": {
        "PORT": "18081",
        "DB_HOST": "localhost",
        "DB_PORT": "15432",
        "DB_USER": "rule_mcp_user",
        "DB_PASSWORD": "rule_mcp_password",
        "DB_NAME": "rule_mcp_db"
      },
      "cwd": "/path/to/your/RuleMCPServer"
    }
  }
}

3. 環境変数なし（JSONファイルモード）

{
  "mcpServers": {
    "rule-mcp": {
      "command": "go",
      "args": ["run", "./cmd/server"],
      "env": {
        "PORT": "18081"
      }
    }
  }
}

設定の説明

パラメータ	説明	必須	デフォルト
`command`	実行するコマンド	✅	`go`
`args`	コマンドの引数	✅	`["run", "./cmd/server"]`
`env`	環境変数	❌	なし
`cwd`	作業ディレクトリ	❌	カレントディレクトリ

環境別の設定例

開発環境（JSONファイルモード）

{
  "mcpServers": {
    "rule-mcp": {
      "command": "go",
      "args": ["run", "./cmd/server"],
      "env": {
        "PORT": "18081"
      }
    }
  }
}

本番環境（PostgreSQL接続）

{
  "mcpServers": {
    "rule-mcp": {
      "command": "go",
      "args": ["run", "./cmd/server"],
      "env": {
        "PORT": "18081",
        "DB_HOST": "your-db-host",
        "DB_PORT": "5432",
        "DB_USER": "your-db-user",
        "DB_PASSWORD": "your-db-password",
        "DB_NAME": "your-db-name"
      }
    }
  }
}

設定ファイルの優先順位

プロジェクト固有: ./cursor-mcp-config.json
ユーザー設定: ~/.cursor/mcp-servers/rule-mcp.json
グローバル設定: ~/.cursor/mcp-servers/rule-mcp.json

トラブルシューティング

よくある問題と解決方法

問題	原因	解決方法
`Method not found`	古いMCPハンドラー	サーバーを再起動
`Connection refused`	ポートが使用中	`lsof -i :18081`で確認
`Database connection failed`	DB接続設定ミス	環境変数を確認
`Permission denied`	ファイル権限	`chmod +x`で実行権限付与

AIエージェントの自動検出

AIエージェントは以下のように自動的にプロジェクトを認識できます：

作業ディレクトリの自動検出
適切なルールセットの取得
言語固有のルール適用
プロジェクト固有のルール適用

これにより、AIエージェントはコンテキストを理解せずに、常に適切なルールでコードレビューや提案を行うことができます。

フロントエンド機能

多言語対応（i18n）

以下の言語をサポート：

英語 (en): デフォルト言語
日本語 (ja): 完全対応
中国語 (zh-CN): 完全対応
ヒンディー語 (hi): 完全対応
スペイン語 (es): 完全対応
アラビア語 (ar): 完全対応（RTL対応）

テーマ切り替え

ライトテーマ: 明るく読みやすい
ダークテーマ: 目に優しい夜間モード
設定の自動保存: ブラウザのlocalStorageに保存

Web UI機能

プロジェクト管理: 作成、編集、削除
ルール管理: プロジェクト固有ルール、グローバルルール
コード検証: リアルタイムでのルール違反チェック
レスポンシブデザイン: モバイル・タブレット対応

📊 監視・メトリクス

Grafana監視ダッシュボード

Rule MCP Serverには包括的な監視システムが組み込まれています。

監視対象メトリクス

Nginx リクエストレート
- HTTPリクエストの処理速度
- ステータスコード別のリクエスト数
Nginx レスポンス時間
- 95パーセンタイルと50パーセンタイルのレスポンス時間
システム統計
- 総ユーザー数
- 総プロジェクト数
- 総ルール数
MCP リクエストレート
- MCPメソッド別のリクエスト数
- 成功・エラー別の統計
MCP レスポンス時間
- MCPリクエストの処理時間
アクティブセッション・APIキー
- 現在アクティブなセッション数
- アクティブなAPIキー数
システム負荷
- CPU使用率
MCP 成功率・エラー率
- リクエストの成功率とエラー率

アクセス方法

開発環境

Grafana: http://localhost:14000
- ユーザー名: admin
- パスワード: admin123
Prometheus: http://localhost:19090

本番環境

Grafana: http://localhost:14000
- ユーザー名: 環境変数 GRAFANA_ADMIN_USER (デフォルト: admin)
- パスワード: 環境変数 GRAFANA_ADMIN_PASSWORD (デフォルト: admin123)
Prometheus: http://localhost:19090

アラート設定

以下のアラートが設定されています：

高エラー率: MCPリクエストのエラー率が10%を超えた場合
高レスポンス時間: 95パーセンタイルのレスポンス時間が1秒を超えた場合
高システム負荷: システム負荷が80%を超えた場合
データベース接続障害: PostgreSQLへの接続が失われた場合
Nginx高エラー率: 5xxエラー率が5%を超えた場合
ディスク容量不足: ディスク使用率が90%を超えた場合

カスタマイズ

ダッシュボードの編集

Grafanaにログイン
ダッシュボードを開く
右上の「設定」ボタンをクリック
「JSON Model」を選択してJSONを編集

新しいメトリクスの追加

internal/interface/handler/metrics_handler.goにメトリクスを追加
ダッシュボードにパネルを追加
Prometheusクエリを設定

アラートルールの追加

prometheus/rules/rule-mcp-alerts.ymlにルールを追加
Prometheusを再起動

詳細はを参照してください。

ルール定義

ルール作成の項目

Rule ID: ルールの一意識別子（例：no-console-log）
Name: ルールの表示名（例：No Console Log）
Description: ルールの内容・目的・理由（例：Console.log statements should not be in production code）
Type: ルールのカテゴリ（naming, formatting, security, performance等）
Severity: 重要度（error, warning, info）
Pattern: 検出する正規表現パターン（例：console\.log）
Message: 違反時の修正指示（例：Console.log detected. Use proper logging framework in production.）
Active: ルールの有効/無効

サンプルルール

{
  "web-app": {
    "project_id": "web-app",
    "rules": [
      {
        "id": "no-console-log",
        "name": "No Console Log",
        "description": "Console.log statements should not be in production code",
        "type": "style",
        "severity": "warning",
        "pattern": "console.log",
        "message": "Console.log detected. Use proper logging framework in production."
      }
    ]
  }
}

設定

環境変数

PORT: サーバーのポート番号（デフォルト: 8080）
HOST: サーバーのホストアドレス（デフォルト: 0.0.0.0）
ENVIRONMENT: 実行環境（development/production、デフォルト: development）
LOG_LEVEL: ログレベル（デフォルト: info）

データベース設定

DB_HOST: データベースホスト（デフォルト: localhost）
DB_PORT: データベースポート（デフォルト: 5432）
DB_NAME: データベース名（デフォルト: rule_mcp_db）
DB_USER: データベースユーザー（デフォルト: rule_mcp_user）
DB_PASSWORD: データベースパスワード

ポート設定

開発者向けにポートの重複を避けるため、以下のポートを使用します：

Rule MCP Server: 18081 (開発) / 18080 (本番)
PostgreSQL: 15432 (ホスト) → 5432 (コンテナ)
Web UI: 13000 (ホスト) → 80 (コンテナ)

これにより、一般的なポート（8080, 5432, 3000）との競合を避けられます。

起動例

ローカル開発

# バックエンド（開発環境）
PORT=18081 go run ./cmd/server

# フロントエンド
cd frontend && npm start

# Makefileを使用
make run           # バックエンド（ポート18081）
make run-frontend  # フロントエンド
make run-prod      # 本番環境（ポート18080）

Docker を使用

# Docker イメージをビルド
make docker-build

# サービスを起動
make docker-up

# サービスを停止
make docker-down

# ログを確認
make docker-logs

# リソースをクリーンアップ
make docker-clean

開発

テスト

# バックエンドテスト
go test ./...

# フロントエンドテスト
cd frontend && npm test

ビルド

# バックエンド
go build -o rule-mcp-server ./cmd/server

# フロントエンド
cd frontend && npm run build

コード品質

# Go言語の品質チェック
make glb

# 全リポジトリの品質チェック
make glb_repo

トラブルシューティング

よくある問題

1. データベース接続エラー

# データベースコンテナの再起動
docker-compose restart postgres

# データベースの完全再作成
docker-compose down -v
docker-compose up -d postgres

2. ポート競合

# 使用中のポートを確認
lsof -i :18081
lsof -i :13000

# 別のポートで起動
PORT=18082 go run ./cmd/server

3. MCPサーバーが応答しない

# サーバーの起動確認
curl http://localhost:18081/api/v1/health

# MCPエンドポイントのテスト
curl -X POST http://localhost:18081/mcp/request \
  -H "Content-Type: application/json" \
  -d '{"id":"test","method":"getRules","params":{"project_id":"web-app"}}'

4. フロントエンドのビルドエラー

# 依存関係の再インストール
cd frontend
rm -rf node_modules package-lock.json
npm install

5. 認証エラー

# APIキーの確認
curl -H "X-API-Key: your_api_key" http://localhost:18081/api/v1/projects

# 権限レベルの確認
curl -H "X-API-Key: your_api_key" http://localhost:18081/api/v1/auth/me

ログ確認

# バックエンドログ
docker logs rule-mcp-server

# データベースログ
docker logs rule-mcp-postgres

# フロントエンドログ
cd frontend && npm start

権限管理システム

アクセスレベル

Rule MCP Serverは3段階のアクセスレベルを提供します：

Public（公開）

認証: 不要
権限: 公開ルール・プロジェクトの閲覧、コード検証
用途: 個人使用、オープンソースプロジェクト
MCPアクセス: 制限なし（レート制限あり）

User（ユーザー）

認証: APIキー必須
権限: 個人ルール・プロジェクトの作成・編集・削除
用途: 個人開発者、小規模チーム
MCPアクセス: 制限なし

Admin（管理者）

認証: 管理者APIキー必須
権限: 全権限（ユーザー管理、グローバルルール管理）
用途: チームリーダー、システム管理者
MCPアクセス: 制限なし

認証方式

APIキー認証

# ヘッダーでの認証
curl -H "X-API-Key: your_api_key" http://localhost:18081/api/v1/projects

# MCPリクエストでの認証
curl -X POST http://localhost:18081/mcp/request \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"id":"test","method":"createRule","params":{...}}'

セッション認証

# ログイン
curl -X POST http://localhost:18081/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"user","password":"password"}'

# セッションでの認証
curl -H "Cookie: session=session_token" http://localhost:18081/api/v1/projects

チーム協働機能

プロジェクトメンバー管理

# チームメンバーの追加
curl -X POST http://localhost:18081/api/v1/projects/team-project/members \
  -H "X-API-Key: admin_key" \
  -H "Content-Type: application/json" \
  -d '{"username":"developer1","role":"member"}'

# チームメンバーの権限確認
curl http://localhost:18081/api/v1/projects/team-project/members \
  -H "X-API-Key: user_key"

プロジェクト可視性

Public: 全ユーザーが閲覧可能
Team: チームメンバーのみ閲覧可能
Private: プロジェクト所有者のみ閲覧可能

権限の細分化

{
  "permissions": {
    "read": true,    // ルール・プロジェクトの閲覧
    "write": true,   // ルール・プロジェクトの作成・編集
    "delete": false, // ルール・プロジェクトの削除
    "admin": false   // メンバー管理
  }
}

設定ファイル

認証設定 (`config/auth.yaml`)

権限レベル、レート制限、セキュリティ設定を定義

環境変数 (`config/environment.md`)

サーバー、データベース、認証、MCP設定の環境変数一覧

MCPクライアント設定

config/simple-mcp-config.json: シンプル版MCP設定（認証なし、初心者向け）
config/mcp-client-config.json: 完全版MCP設定（認証・チーム機能対応）

データベーススキーマ (`init.sql`)

権限管理テーブル、ユーザー管理、チーム協働機能を含む完全なスキーマ

セキュリティ機能

レート制限

Public: 50 req/min（制限付き）
User: 100 req/min
Admin: 200 req/min

監査ログ

認証試行の記録
権限変更の記録
ルール変更の記録
保持期間: 365日

パスワードポリシー

最小8文字
大文字・小文字・数字・特殊文字必須
セッションタイムアウト: 8時間

APIキーセキュリティ

bcryptハッシュ化
有効期限設定
HTTPS必須（本番環境）
使用ログ記録

使用例

個人使用（Public）

# 認証なしでルール取得
curl http://localhost:18081/api/v1/rules?project_id=web-app

# MCP経由でコード検証
curl -X POST http://localhost:18081/mcp/request \
  -H "Content-Type: application/json" \
  -d '{"id":"test","method":"validateCode","params":{"project_id":"web-app","code":"console.log(\"test\")"}}'

チーム使用（User/Admin）

# APIキーでルール作成
curl -X POST http://localhost:18081/api/v1/rules \
  -H "X-API-Key: user_key" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"team-project","rule_id":"no-todo","name":"No TODO","type":"quality","severity":"warning","pattern":"TODO:","message":"TODO comment detected"}'

# チームメンバー管理
curl -X POST http://localhost:18081/api/v1/projects/team-project/members \
  -H "X-API-Key: admin_key" \
  -H "Content-Type: application/json" \
  -d '{"username":"new_dev","role":"member"}'

MCPクライアント設定

Cursor

// ~/.cursor/mcp.json
{
  "mcpServers": {
    "rule-mcp-server": {
      "command": "pnpm",
      "args": [
        "dlx",
        "rule-mcp-server"
      ],
      "env": {
        "RULE_SERVER_URL": "http://localhost:18080",
        "MCP_API_KEY": "${MCP_API_KEY:-}"
      },
      "description": "Standard MCP Server for Rule Management - provides coding rules and validation tools for AI agents",
      "disabled": false,
      "autoApprove": []
    }
  }
}

Claude Desktop

// ~/Library/Application Support/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "rule-mcp-server": {
      "command": "pnpm",
      "args": [
        "dlx",
        "rule-mcp-server"
      ],
      "env": {
        "RULE_SERVER_URL": "http://localhost:18080",
        "MCP_API_KEY": "${MCP_API_KEY:-}"
      },
      "description": "Standard MCP Server for Rule Management - provides coding rules and validation tools for AI agents",
      "disabled": false,
      "autoApprove": []
    }
  }
}

補足: MCP_API_KEY は未設定でも動作します（Publicアクセス）。チーム運用や管理APIを使う場合にのみ設定してください。

🚀 クイックスタート

pnpmパッケージ使用（推奨）

# 1. MCPサーバーをインストール（またはpnpm dlxで自動インストール）
pnpm add -g rule-mcp-server

# 2. 設定ファイルを作成
cp config/pnpm-mcp-config.template.json ~/.cursor/mcp.json

# 3. AIエージェント（Cursor/Claude Desktop/Cline）で利用開始！

📦 npmパッケージ: rule-mcp-server として公開済み

Docker環境

# 1. リポジトリをクローン
git clone https://github.com/AkitoSakurabaCreator/Rule-MCP-Server.git
cd Rule-MCP-Server

# 2. Docker環境を起動
make docker-up

# 3. MCPサーバーをビルド
make install-mcp && make build-mcp

# 4. 設定ファイルを作成
cp config/docker-mcp-config.template.json ~/.cursor/mcp_settings.json
# パスを編集: ${PROJECT_PATH} → /path/to/your/Rule-MCP-Server

# 5. AIエージェント（Cursor/Cline）で利用開始！

開発環境

# 1. 依存関係のインストール
go mod tidy
cd frontend && npm install && cd ..

# 2. サーバー起動
make run        # バックエンド（ポート18081）
make run-frontend  # フロントエンド（ポート3000）

# 3. MCPサーバーをビルド
make install-mcp && make build-mcp

# 4. 設定ファイルを作成
cp config/standard-mcp-config.template.json ~/.cursor/mcp_settings.json

🌟 主な特徴

✅ 標準MCP準拠

完全なMCP互換性: @modelcontextprotocol/sdk使用
標準的なツール・リソース: AIエージェントとの完璧な統合
StdioServerTransport: 標準的な通信プロトコル

✅ 豊富な機能

6つのMCPツール: ルール取得、コード検証、プロジェクト自動検出など
5つのMCPリソース: プロジェクト一覧、ルール情報、グローバルルール
プロジェクト自動検出: AIが自動的に適切なルールを適用

✅ 本番対応

Docker環境: 安定した本番運用
PostgreSQL: 高性能データベース
認証・認可: APIキー、セッション認証
多言語対応: 6言語サポート（日本語、英語、中国語など）

✅ 開発者フレンドリー

クリーンアーキテクチャ: 保守性の高い設計
Web UI: React製の管理画面
テンプレート設定: 簡単セットアップ
豊富なドキュメント: 詳細な使用方法

🎯 使用ケース

個人開発者

# 認証なしで簡単利用
curl http://localhost:18080/api/v1/rules?project_id=my-project

チーム開発

# APIキーでチーム管理
curl -H "X-API-Key: team_key" http://localhost:18080/api/v1/projects

AIエージェント統合

// Cursor/Clineで自動ルール適用
{
  "mcpServers": {
    "rule-mcp-server": {
      "command": "node",
      "args": ["/path/to/Rule-MCP-Server/cmd/mcp-server/build/index.js"],
      "env": {
        "RULE_SERVER_URL": "http://localhost:18080"
      }
    }
  }
}

📊 システム要件

最小要件

OS: Linux, macOS, Windows
Go: 1.21+
Node.js: 18+
Docker: 20.10+ (推奨)

推奨要件

メモリ: 2GB以上
ストレージ: 1GB以上
CPU: 2コア以上

🔧 開発・貢献

開発環境のセットアップ

# 1. フォーク & クローン
git clone https://github.com/your-username/Rule-MCP-Server.git
cd Rule-MCP-Server

# 2. 開発用ブランチ作成
git checkout -b feature/your-feature

# 3. 依存関係インストール
make deps
make install-mcp

# 4. 開発サーバー起動
make run
make run-frontend

テスト実行

# バックエンドテスト
make test

# フロントエンドテスト
cd frontend && npm test

# MCPサーバーテスト
cd cmd/mcp-server && npm test

コード品質チェック

# Go言語
make fmt
make lint

# TypeScript
cd cmd/mcp-server && npm run lint

🤝 貢献ガイドライン

貢献の流れ

Issue作成: バグ報告や機能提案
フォーク: リポジトリをフォーク
ブランチ作成: feature/your-feature または fix/your-fix
開発: コード変更とテスト追加
プルリクエスト: 詳細な説明と共に提出

コミットメッセージ規約

# 機能追加
feat: add project auto-detection feature

# バグ修正
fix: resolve MCP server connection issue

# ドキュメント更新
docs: update README with Docker setup

# リファクタリング
refactor: improve error handling in MCP handlers

開発のベストプラクティス

テスト: 新機能には必ずテストを追加
ドキュメント: APIの変更は必ずドキュメント更新
型安全性: TypeScriptの型定義を適切に使用
エラーハンドリング: 適切なエラーメッセージとログ出力

🏆 コミュニティ

貢献者

このプロジェクトは以下の素晴らしい貢献者によって支えられています：

@AkitoSakurabaCreator - プロジェクト創設者・メンテナー

謝辞

Model Context Protocol: 標準的なAIエージェント統合を可能にする素晴らしいプロトコル
Go Community: 高性能なバックエンド開発環境
React Community: 優れたフロントエンド開発体験
Docker: 一貫した開発・本番環境

📄 ライセンス

MIT License - 詳細はファイルを参照してください。

🆘 サポート・コミュニティ

問題報告・質問

🐛 バグ報告: GitHub Issues
💡 機能提案: GitHub Issues
❓ 質問・議論: GitHub Discussions

ドキュメント

📚 詳細ドキュメント: GitHub Wiki

コミュニティ

💬 Discord: Rule MCP Server Community
🐦 X (旧Twitter): @_sakuraba_akito

📋 貢献ガイドライン

貢献の流れ

Issue作成: バグ報告や機能提案
フォーク: リポジトリをフォーク
ブランチ作成: feature/your-feature または fix/your-fix
開発: コード変更とテスト追加
プルリクエスト: 詳細な説明と共に提出

詳細はを参照してください。

📜 ライセンス

MIT License - 詳細はファイルを参照してください。

🔒 セキュリティ

セキュリティに関する問題を発見した場合は、の手順に従って報告してください。

📝 行動規範

このプロジェクトはに従って運営されています。

📈 変更履歴

最新の変更履歴はを参照してください。

⭐ このプロジェクトが役に立ったら、GitHubでスターをお願いします！

🚀 AIエージェントとの統合で、より良いコード品質を実現しましょう！