Jooq MCP

🚀 jOOQ MCP Server

Model Context Protocol (MCP)サーバーで、AIモデルがjOOQのドキュメントにアクセスできるようにします。このSpring Bootアプリケーションは、Spring AIを使用して、jOOQのドキュメントをMCPツールとして公開し、AIシステムがjOOQの機能、SQLの例、ベストプラクティスに関する情報をクエリして取得できるようにします。

✨ 主な機能

MCPサーバーは以下のツールを提供します：

• searchDocumentation：特定のトピックに関するjOOQのドキュメントを検索します。
• getSqlExamples：特定の操作に関するSQLクエリ構築の例を取得します。
• getCodeGenerationGuide：jOOQのコード生成ドキュメントを取得します。
• getDatabaseSupport：データベース固有のサポート情報を取得します。
• getQueryDslReference：特定のステートメントタイプに関するQuery DSLのリファレンスを取得します。
• getAdvancedFeatures：高度なjOOQ機能のドキュメントにアクセスします。

🚀 クイックスタート

前提条件

• Java 21以上
• Maven 3.6以上

アプリケーションの実行

1. リポジトリをクローンします：

   git clone <repository-url>
   cd jooq-mcp
   

2. プロジェクトをビルドします：

   ./mvnw clean install
   

3. アプリケーションを実行します：

   ./mvnw spring-boot:run
   

MCPサーバーが起動し、MCPクライアントからの接続を受け付けるようになります。

Dockerでのデプロイ

1. JARファイルをビルドします：

   ./mvnw clean package
   

2. Dockerイメージをビルドします：

   docker build -t jooq-mcp .
   

3. Dockerコンテナを実行します：

   docker run -p 8080:8080 jooq-mcp
   

Fly.ioでのデプロイ

このアプリケーションはFly.ioでのデプロイが設定されています：

1. Fly CLIをインストールして認証します：

   brew install flyctl  # または好みのインストール方法を使用
   fly auth login
   

2. アプリケーションをデプロイします：

   ./mvnw clean package
   fly deploy
   

アプリケーションには/actuator/healthでヘルスチェックが含まれており、自動スケーリングが設定されています。

MCPクライアントとの使用

このサーバーは、MCP互換のAIクライアントと一緒に使用できます。サーバーは、AIモデルが以下のことを行えるようにするツールを公開します：

• キーワードでjOOQのドキュメントを検索する
• 特定のSQLの例やコードスニペットを取得する
• データベース固有の構成情報にアクセスする
• コード生成の設定に関するガイダンスを取得する
• 高度なjOOQ機能に関する情報を見つける

設定

アプリケーションはapplication.propertiesを介して設定できます：

# MCP Server Configuration
spring.ai.mcp.server.name=jooq-documentation-mcp
spring.ai.mcp.server.version=1.0.0
spring.ai.mcp.server.type=SYNC
spring.ai.mcp.server.capabilities.tool=true

# Cache Configuration
spring.cache.type=caffeine
spring.cache.caffeine.spec=maximumSize=100,expireAfterWrite=1h

# jOOQ Documentation Crawler Configuration
jooq.documentation.crawler.max-depth=4
jooq.documentation.crawler.max-urls-per-section=100
jooq.documentation.crawler.timeout-ms=10000
jooq.documentation.crawler.cache-duration-hours=24

# Server Configuration - SSE Buffer Settings
server.tomcat.max-http-response-header-size=64KB
server.tomcat.max-swallow-size=10MB

使用例

MCPクライアントに接続したら、以下のような質問をすることができます：

• "jOOQでSELECT文を作成するにはどうすればいいですか？"
• "jOOQのINSERT操作の例を見せてください"
• "jOOQはどのデータベースをサポートしていますか？"
• "jOOQのコード生成を設定するにはどうすればいいですか？"
• "jOOQでトランザクションを使用するにはどうすればいいですか？"

サーバーは関連するドキュメントを取得し、コード例を含む詳細な回答を提供します。

🔧 技術詳細

アプリケーションは以下の要素で構成されています：

• JooqDocumentationService：MCP統合のために@Toolアノテーション付きのメソッドを持つ主要なサービスクラス
• LocalJooqDocumentationService：TF-IDFスコアリングを使用したローカルドキュメントのインデックス作成と全文検索を提供します。
• InvertedIndex：関連性スコアリングを伴う高度な全文検索機能を実装します。
• JooqDocumentationCrawler：jOOQのドキュメントをクロールしてローカルに保存します。
• JooqDocumentationFetcher：ドキュメントコンテンツの解析と抽出を処理します。
• McpConfiguration：MCPツールの登録のためのSpring設定
• Caching：パフォーマンス向上のためのCaffeineベースのキャッシング

主要な機能

• ローカルドキュメント保存：ドキュメントはsrc/main/resources/docs/にローカルに保存され、高速アクセスが可能です。
• 全文検索：TF-IDFスコアリングを使用した高度な検索で、より関連性の高い結果が得られます。
• 効率的なインデックス作成：高速なドキュメント検索のためのメモリ内逆インデックス
• コード例の抽出：コード例の自動抽出と分類

🧪 テスト

テストスイートを実行します：

./mvnw test

👨‍💻 開発

このアプリケーションは以下を使用しています：

• Spring Boot 3.5.4
• Spring AI 1.0.0（MCPサーバーサポート付き）
• JSoup（HTML解析用）
• Caffeine（キャッシング用）

新しいツールを追加するには、JooqDocumentationServiceクラスに@Toolアノテーション付きのメソッドを作成します。