Jooq MCP

🚀 jOOQ MCP 服務器

jOOQ MCP 服務器是一個基於模型上下文協議（MCP）的服務器，它為 AI 模型提供了訪問 jOOQ 文檔的途徑。這個 Spring Boot 應用程序藉助 Spring AI 將 jOOQ 文檔作為 MCP 工具公開，使 AI 系統能夠查詢和獲取有關 jOOQ 特性、SQL 示例和最佳實踐的信息。

🚀 快速開始

前提條件

• 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 服務器配置
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

# 緩存配置
spring.cache.type=caffeine
spring.cache.caffeine.spec=maximumSize=100,expireAfterWrite=1h

# jOOQ 文檔爬蟲配置
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

# 服務器配置 - SSE 緩衝區設置
server.tomcat.max-http-response-header-size=64KB
server.tomcat.max-swallow-size=10MB

使用示例

連接到 MCP 客戶端後，你可以提出以下問題：

• “如何在 jOOQ 中創建 SELECT 語句？”
• “展示 jOOQ INSERT 操作的示例”
• “jOOQ 支持哪些數據庫？”
• “如何配置 jOOQ 代碼生成？”
• “如何在 jOOQ 中使用事務？” 服務器將獲取相關文檔並提供帶有代碼示例的詳細答案。

✨ 主要特性

MCP 服務器提供以下工具：

• searchDocumentation：搜索 jOOQ 文檔中的特定主題
• getSqlExamples：獲取特定操作的 SQL 查詢構建示例
• getCodeGenerationGuide：檢索 jOOQ 代碼生成文檔
• getDatabaseSupport：獲取特定數據庫的支持信息
• getQueryDslReference：獲取特定語句類型的 Query DSL 參考
• getAdvancedFeatures：訪問 jOOQ 高級特性的文檔

🔧 技術細節

架構

該應用程序由以下部分組成：

• JooqDocumentationService：主服務類，帶有用於 MCP 集成的 @Tool 註解方法
• LocalJooqDocumentationService：提供本地文檔索引和基於 TF-IDF 評分的全文搜索
• InvertedIndex：實現具有相關性評分的高級全文搜索功能
• JooqDocumentationCrawler：爬取並獲取 jOOQ 文檔以進行本地存儲
• JooqDocumentationFetcher：處理文檔內容的解析和提取
• McpConfiguration：用於 MCP 工具註冊的 Spring 配置
• 緩存：基於 Caffeine 的緩存以提高性能

關鍵特性

• 本地文檔存儲：文檔本地存儲在 src/main/resources/docs/ 中，以便更快地訪問
• 全文搜索：使用 TF-IDF 評分進行高級搜索，以提高相關性
• 高效索引：內存中的倒排索引，用於快速文檔檢索
• 代碼示例提取：自動提取和分類代碼示例

🧪 測試

運行測試套件：

./mvnw test

💻 開發

該應用程序使用以下技術：

• Spring Boot 3.5.4
• 支持 MCP 服務器的 Spring AI 1.0.0
• 用於 HTML 解析的 JSoup
• 用於緩存的 Caffeine 若要添加新工具，請在 JooqDocumentationService 類中創建帶有 @Tool 註解的方法。