Skip to content

Commit ea64584

Browse files
authored
🔧 chore(repository): 统一主页剩余文件元数据 (#126)
1 parent a715b8b commit ea64584

10 files changed

Lines changed: 46 additions & 38 deletions

File tree

‎.dockerignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ venv
3434
.vscode
3535
*.swp
3636

37-
# Node (npm wrapper 不进运行镜像)
37+
# Node(运行镜像直接启动 Python CLI,npm wrapper 不进入构建上下文)
3838
node_modules
3939
package*.json
4040
index.js

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ uv pip install -e ".[dev]"
2121
PYTHONPATH=src uv run pytest tests/unit/ -q
2222
uv run ruff check src/ tests/
2323
uv run ruff format --check src/ tests/
24+
25+
# 验证 sb35-java21 模板的代表性 Maven 编译路径(需要 Java 21 与 Maven)
26+
PYTHONPATH=src uv run python scripts/verify_java_compile.py
2427
```
2528

2629
数据库集成测试需要显式配置 `DBJAVAGENIX_TEST_*` 环境变量,详见 [`tests/README.md`](tests/README.md)。

‎README.es-ES.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,19 @@ graph LR
1515
Skills[".claude/skills/<br/>java-codegen-from-db<br/>springboot-migration"]
1616
Skills -->|Llamada según necesidad| MCP
1717
18-
subgraph MCP[Servidor MCP 29 herramientas]
18+
subgraph MCP[Servidor MCP 33 herramientas]
1919
direction TB
2020
DB[db_* conexión / consulta / descripción]
21-
Atom[codegen_build_context<br/>codegen_render_entity/dao/service/<br/>controller/mapper]
21+
Atom[codegen_build_context<br/>codegen_render_entity/dao/service/<br/>controller/dto/mapper]
22+
Graph[schema_topo_order<br/>schema_cluster_tables<br/>schema_check_cycles]
2223
AI[ai_infer_business_names<br/>ai_recommend_template<br/>ai_summarize_schema]
2324
Vis[db_render_er_diagram]
2425
Obs[server_metrics / server_health<br/>ai_metrics / search_tools]
2526
end
2627
2728
MCP -->|Retorna _meta| Apps[Renderizado MCP Apps]
2829
Apps -->|mermaid / dashboard / code-diff / tree| Client
29-
MCP -->|Lee| Data[MySQL / SQLite + plantillas Mustache]
30+
MCP -->|Lee| Data[MySQL / PostgreSQL / SQLite + plantillas Mustache]
3031
```
3132

3233
## ¿Qué problema resuelve?
@@ -36,7 +37,7 @@ Generar ingeniería inversa de tablas de bases de datos a proyectos Spring Boot
3637
| Dimensión | Herramientas antiguas | DBJavaGenix v0.2 |
3738
|------|--------|------------------|
3839
| ¿Quién define el flujo? | El usuario hace clic en paneles de configuración en el IDE | **Orquestación explícita mediante archivos Skill** (el LLM no llama erróneamente) |
39-
| Granularidad de llamada | Un solo botón hace todo de golpe | **6 herramientas atómicas** (build_context + 5 render_*), el LLM permite al usuario modificar el contexto para regenerar |
40+
| Granularidad de llamada | Un solo botón hace todo de golpe | **7 herramientas atómicas** (build_context + 6 render_*), el LLM permite al usuario modificar el contexto para regenerar |
4041
| Sobrecarga de inicio | (Plugin, residente) | Predeterminado ~3300 tok / modo progresivo **~985 tok** (ahorro del 70%) |
4142
| Nomenclatura | Mapeo mecánico de prefijos de tabla | **15 reglas + API de Claude**, identifica patrones RBAC/ecommerce/CMS |
4243
| Visualización de salida | Texto dentro del IDE | **MCP Apps**: Diagrama ER Mermaid / panel de dependencias / code-diff / árbol de estructura de paquetes |
@@ -95,7 +96,7 @@ En el cliente LLM, di "**Genera código Spring Boot a partir de las tres tablas
9596

9697
### Fase 2: Capa de Skills y herramientas atómicas
9798
- `.claude/skills/java-codegen-from-db/SKILL.md` define explícitamente el flujo de trabajo de 5 fases
98-
- `db_codegen_generate` se divide en 6 herramientas atómicas, con contexto transferido explícitamente
99+
- `db_codegen_generate` se divide en 7 herramientas atómicas, con contexto transferido explícitamente
99100
- La herramienta `search_tools` implementa descubrimiento progresivo, ahorrando un 70.2% de tokens de inicio
100101
- Segunda Skill `springboot-migration` (lista de verificación de actualización 2.7→3.x)
101102
- [token usage benchmark](docs/benchmarks/token-usage.md)
@@ -125,13 +126,14 @@ En el cliente LLM, di "**Genera código Spring Boot a partir de las tres tablas
125126
- Logs estructurados: `DBJAVAGENIX_LOG_FORMAT=json` permite salida de JSON en una sola línea, ideal para Loki/ELK
126127
- [Manual de despliegue](docs/deployment.md): 3 modos de despliegue + 6 escenarios de troubleshooting
127128

128-
## Resumen de herramientas (29 en total)
129+
## Resumen de herramientas (33 en total)
129130

130131
| Categoría | Herramienta |
131132
|------|------|
132133
| Conexión / Consulta | db_connect_test / db_query_databases / db_query_tables / db_query_table_exists / db_query_execute |
133134
| Estructura de tabla | db_table_describe / db_table_columns / db_table_primary_keys / db_table_foreign_keys / db_table_indexes |
134-
| Generación de código (atómica) | codegen_build_context / codegen_render_entity / codegen_render_dao / codegen_render_service / codegen_render_controller / codegen_render_mapper |
135+
| Algoritmos de grafo de schema | schema_topo_order / schema_cluster_tables / schema_check_cycles |
136+
| Generación de código (atómica) | codegen_build_context / codegen_render_entity / codegen_render_dao / codegen_render_service / codegen_render_controller / codegen_render_dto / codegen_render_mapper |
135137
| Generación de código (legada) | db_codegen_analyze / db_codegen_generate |
136138
| Proyectos Spring Boot | springboot_validate_project / springboot_analyze_dependencies / springboot_read_config |
137139
| Visualización | db_render_er_diagram |
@@ -145,7 +147,7 @@ En el cliente LLM, di "**Genera código Spring Boot a partir de las tres tablas
145147
|------|------------------|----------|----------------------|-----------------|
146148
| Motor de ejecución | LLM + MCP | Plugin para IDEA | Línea de comandos / Plugin Maven | Interfaz Web |
147149
| Orquestación de flujo | Skill explícita de 5 fases | Panel de configuración | Código único | Formulario |
148-
| Granularidad de herramienta | 6 atómicas (permite corrección intermedia) | Botón único | Comando único | Botón único |
150+
| Granularidad de herramienta | 7 atómicas (permite corrección intermedia) | Botón único | Comando único | Botón único |
149151
| Nomenclatura IA | ✅ 15 reglas + LLM opcional | ❌ Solo plantillas | ❌ | ❌ |
150152
| Extensión de plantillas | ✅ Mustache + 4 categorías (incluye sb35-java21) | ✅ Velocity | ⚠️ Solo MybatisPlus | ⚠️ Solo freemarker |
151153
| Renderizado de diagrama ER | ✅ Mermaid (MCP App) | ❌ | ❌ | ⚠️ Estático |
@@ -160,7 +162,7 @@ Consulta [`iteration-plan/01-target-architecture.md`](iteration-plan/01-target-a
160162
```
161163
[ Capa Skills ] Define "cómo hacerlo" — .claude/skills/*.md Flujo de 5 fases explícito
162164
↓
163-
[ Capa MCP ] Proporciona "qué se puede hacer" — 29 herramientas atómicas Contexto transferido explícitamente
165+
[ Capa MCP ] Proporciona "qué se puede hacer" — 33 herramientas Contexto transferido explícitamente
164166
↓
165167
[ Capa Apps ] Hace los resultados "visibles" — 4 componentes de UI (mermaid/dashboard/code-diff/tree)
166168
```
@@ -177,6 +179,7 @@ Cada capa practica "contención de ingeniería":
177179
| [iteration-plan/](iteration-plan/) | Plan de refactorización en 6 fases (arquitectura objetivo / roadmap / registro de decisiones / historias de demostración) |
178180
| [docs/deployment.md](docs/deployment.md) | Modos de despliegue / Variables de entorno / Health check / Solución de problemas |
179181
| [docs/benchmarks/token-usage.md](docs/benchmarks/token-usage.md) | Medición de tokens del schema de herramientas |
182+
| [docs/roadmap-v0.3.md](docs/roadmap-v0.3.md) | Plan de cierre para arquitectura, integración, calidad y publicación |
180183
| [docs/screenshots/README.md](docs/screenshots/README.md) | Compatibilidad del cliente con 4 componentes MCP Apps |
181184
| [docs/algorithms-overview.md](docs/algorithms-overview.md) | Algoritmos de gráficos de schema v0.2.1 (topo / cluster / cycle) |
182185
| [docs/design-patterns-catalog.md](docs/design-patterns-catalog.md) | Patrones de diseño en el generador y en el código generado |
@@ -195,12 +198,9 @@ Cada capa practica "contención de ingeniería":
195198
- [x] **v0.2.1**: Completado de ingeniería Java (3 algoritmos de schema / generador de configuración de estándares / catálogo de patrones)
196199
- [x] **v0.2.2**: MCP v3 + Ingeniería de IA (formularios de elicitation / sampling con LLM / caché de prompts 1h / agentic-runner)
197200

198-
Próximos pasos (candidato v0.3):
199-
- Expansión de backend DB: soporte completo para PostgreSQL / Oracle
200-
- Captura de capturas de pantalla de Claude Desktop / Cursor al repositorio (cierre de P3.5)
201-
- Pruebas de integración: levantar MySQL con Testcontainers para ejecutar end-to-end
202-
- Rendimiento: fusionar la inferencia de reglas y la ruta de LLM en un mismo schema de retorno (el formato actual de la ruta LLM difiere ligeramente de las reglas)
203-
- Agregar soporte para subagentes en agentic-runner (SDK de Agent ya está listo)
201+
Próximos pasos (v0.3):
202+
- Las prioridades, requisitos previos y evidencias de aceptación se mantienen en [`docs/roadmap-v0.3.md`](docs/roadmap-v0.3.md).
203+
- La lista describe candidatos; no comunica mejoras de rendimiento ni soporte de base de datos no verificados.
204204

205205
## Modos de inicio
206206

‎README.ja-JP.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,19 @@ graph LR
1313
Skills[".claude/skills/<br/>java-codegen-from-db<br/>springboot-migration"]
1414
Skills -->|必要に応じて呼び出し| MCP
1515
16-
subgraph MCP[MCP Server 29 ツール]
16+
subgraph MCP[MCP Server 33 ツール]
1717
direction TB
1818
DB[db_* 接続 / クエリ / 説明]
19-
Atom[codegen_build_context<br/>codegen_render_entity/dao/service/<br/>controller/mapper]
19+
Atom[codegen_build_context<br/>codegen_render_entity/dao/service/<br/>controller/dto/mapper]
20+
Graph[schema_topo_order<br/>schema_cluster_tables<br/>schema_check_cycles]
2021
AI[ai_infer_business_names<br/>ai_recommend_template<br/>ai_summarize_schema]
2122
Vis[db_render_er_diagram]
2223
Obs[server_metrics / server_health<br/>ai_metrics / search_tools]
2324
end
2425
2526
MCP -->|_meta を返却| Apps[MCP Apps レンダリング]
2627
Apps -->|mermaid / dashboard / code-diff / tree| Client
27-
MCP -->|読み込み| Data[MySQL / SQLite + Mustache テンプレート]
28+
MCP -->|読み込み| Data[MySQL / PostgreSQL / SQLite + Mustache テンプレート]
2829
```
2930

3031
## 解決する課題
@@ -34,7 +35,7 @@ graph LR
3435
| 観点 | 従来のツール | DBJavaGenix v0.2 |
3536
|------|-------------|------------------|
3637
| ワークフローの定義者 | IDE の設定画面をユーザーが操作 | **Skill ファイルで明示的に編成**(LLM の誤呼び出しを防止) |
37-
| 呼び出し単位 | 1 つのボタンですべてを一括実行 | **6 つのアトミックツール**(build_context + 5 つの render_*)。途中で context を修正して再生成可能 |
38+
| 呼び出し単位 | 1 つのボタンですべてを一括実行 | **7 つのアトミックツール**(build_context + 6 つの render_*)。途中で context を修正して再生成可能 |
3839
| 起動コスト | プラグインを常駐 | 通常約 3,300 tok / Progressive モード **約 985 tok**(70% 削減) |
3940
| 命名 | テーブル接頭辞の機械的な変換 | **15 のルール + Claude API** で RBAC / EC / CMS パターンを認識 |
4041
| 出力の可視化 | IDE 内のテキスト | **MCP Apps**: Mermaid ER 図 / 依存関係ダッシュボード / code-diff / パッケージツリー |
@@ -96,7 +97,7 @@ LLM クライアントで、例えば **「myapp データベースの sys_user
9697
### Phase 2: Skills 層とアトミックツール
9798

9899
- `.claude/skills/java-codegen-from-db/SKILL.md` が 5 段階のワークフローを明示
99-
- `db_codegen_generate` を 6 つのアトミックツールへ分割し、context を明示的に受け渡し
100+
- `db_codegen_generate` を 7 つのアトミックツールへ分割し、context を明示的に受け渡し
100101
- `search_tools` が Progressive Discovery を実装し、起動時のトークンを 70.2% 削減
101102
- 2 つ目の Skill `springboot-migration`(2.7 → 3.x 移行チェックリスト)
102103
- [トークン使用量ベンチマーク](docs/benchmarks/token-usage.md)
@@ -129,13 +130,14 @@ LLM クライアントで、例えば **「myapp データベースの sys_user
129130
- 構造化ログ: `DBJAVAGENIX_LOG_FORMAT=json` で Loki / ELK に適した 1 行 JSON を出力
130131
- [デプロイガイド](docs/deployment.md): 3 つのデプロイ方式 + 6 つのトラブルシューティング事例
131132

132-
## ツール一覧(29 個)
133+
## ツール一覧(33 個)
133134

134135
| カテゴリ | ツール |
135136
|------|------|
136137
| 接続 / クエリ | db_connect_test / db_query_databases / db_query_tables / db_query_table_exists / db_query_execute |
137138
| テーブル構造 | db_table_describe / db_table_columns / db_table_primary_keys / db_table_foreign_keys / db_table_indexes |
138-
| コード生成(アトミック) | codegen_build_context / codegen_render_entity / codegen_render_dao / codegen_render_service / codegen_render_controller / codegen_render_mapper |
139+
| スキーマグラフアルゴリズム | schema_topo_order / schema_cluster_tables / schema_check_cycles |
140+
| コード生成(アトミック) | codegen_build_context / codegen_render_entity / codegen_render_dao / codegen_render_service / codegen_render_controller / codegen_render_dto / codegen_render_mapper |
139141
| コード生成(レガシー) | db_codegen_analyze / db_codegen_generate |
140142
| Spring Boot プロジェクト | springboot_validate_project / springboot_analyze_dependencies / springboot_read_config |
141143
| 可視化 | db_render_er_diagram |
@@ -149,7 +151,7 @@ LLM クライアントで、例えば **「myapp データベースの sys_user
149151
|------|------------------|----------|----------------------|-----------------|
150152
| 実行方式 | LLM + MCP | IDEA プラグイン | CLI / Maven plugin | Web UI |
151153
| ワークフロー編成 | 5 段階の明示的な Skill | 設定画面 | 一括生成 | フォーム |
152-
| ツール粒度 | 6 つのアトミックツール(途中修正可能) | 1 ボタン | 1 コマンド | 1 ボタン |
154+
| ツール粒度 | 7 つのアトミックツール(途中修正可能) | 1 ボタン | 1 コマンド | 1 ボタン |
153155
| AI 命名 | ✅ 15 ルール + オプション LLM | ❌ テンプレートのみ | ❌ | ❌ |
154156
| テンプレート拡張 | ✅ Mustache + 4 カテゴリ(sb35-java21 を含む) | ✅ Velocity | ⚠️ MybatisPlus のみ | ⚠️ freemarker のみ |
155157
| ER 図の描画 | ✅ Mermaid(MCP App) | ❌ | ❌ | ⚠️ 静的 |
@@ -164,7 +166,7 @@ LLM クライアントで、例えば **「myapp データベースの sys_user
164166
```
165167
[ Skills 層 ] 「方法」を定義 — .claude/skills/*.md 明示的な 5 段階ワークフロー
166168
↓
167-
[ MCP 層 ] 「できること」を提供 — 29 のアトミックツール context を明示的に受け渡し
169+
[ MCP 層 ] 「できること」を提供 — 33 ツール context を明示的に受け渡し
168170
↓
169171
[ Apps 層 ] 結果を「見える化」 — 4 つの UI コンポーネント(mermaid/dashboard/code-diff/tree)
170172
```
@@ -182,6 +184,7 @@ LLM クライアントで、例えば **「myapp データベースの sys_user
182184
| [iteration-plan/](iteration-plan/) | 6 段階のリファクタリング計画(目標アーキテクチャ / ロードマップ / 意思決定記録 / デモストーリー) |
183185
| [docs/deployment.md](docs/deployment.md) | デプロイ方式 / 環境変数 / ヘルスチェック / トラブルシューティング |
184186
| [docs/benchmarks/token-usage.md](docs/benchmarks/token-usage.md) | ツールスキーマのトークン測定 |
187+
| [docs/roadmap-v0.3.md](docs/roadmap-v0.3.md) | アーキテクチャ、統合、品質、リリースの収束計画 |
185188
| [docs/screenshots/README.md](docs/screenshots/README.md) | 4 つの MCP Apps コンポーネントのクライアント互換性 |
186189
| [docs/algorithms-overview.md](docs/algorithms-overview.md) | v0.2.1 スキーマグラフアルゴリズム(topo / cluster / cycle) |
187190
| [docs/design-patterns-catalog.md](docs/design-patterns-catalog.md) | ジェネレーターと生成コードのデザインパターン |
@@ -202,11 +205,8 @@ LLM クライアントで、例えば **「myapp データベースの sys_user
202205

203206
次の候補(v0.3):
204207

205-
- DB バックエンドの拡張: PostgreSQL / Oracle の完全サポート
206-
- Claude Desktop / Cursor のスクリーンショットをリポジトリに追加(P3.5 の仕上げ)
207-
- 統合テスト: Testcontainers で MySQL を起動し、エンドツーエンドで実行
208-
- パフォーマンス: ルール推論と LLM 経路の返却 schema を統一
209-
- agentic-runner のサブエージェント対応(Agent SDK は準備済み)
208+
- 優先順位、前提条件、受け入れ証拠は [`docs/roadmap-v0.3.md`](docs/roadmap-v0.3.md) で管理します。
209+
- この一覧は候補であり、未検証の性能改善やデータベース対応を表明するものではありません。
210210

211211
## 起動モード
212212

‎docker-compose.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
version: "3.9"
2-
31
# 本地开发: 跑一个连着 MCP server 的 stdio 容器, 同时提供一个 MySQL
42
# 测试数据库便于集成测试。
53
#

‎index.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,15 @@
1212
const { spawn } = require('child_process');
1313
const path = require('path');
1414
const fs = require('fs');
15+
const { version } = require('./package.json');
1516

1617
const projectDir = __dirname;
1718
const srcDir = path.join(projectDir, 'src');
1819

1920
// 用 stderr 输出启动信息, stdout 留给 MCP JSON-RPC.
2021
const log = (...args) => process.stderr.write(args.join(' ') + '\n');
2122

22-
log('DBJavaGenix MCP Server v0.1.0');
23+
log(`DBJavaGenix MCP Server v${version}`);
2324
log('Starting Python backend in stdio mode...');
2425

2526
if (!fs.existsSync(srcDir) || !fs.existsSync(path.join(srcDir, 'dbjavagenix'))) {

‎iteration-plan/README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1-
# README.md
1+
# iteration-plan 归档说明
22

3-
(content saved separately - see git history)
3+
本目录保留项目早期迭代计划和草稿,作为已完成阶段的历史资料;它不是当前功能承诺的来源。
4+
5+
当前架构、集成、质量与发布的优先级、前置条件和验收证据见
6+
[`docs/roadmap-v0.3.md`](../docs/roadmap-v0.3.md)。已采纳的架构决策见
7+
[`docs/adr/`](../docs/adr/)。

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "dbjavagenix-mcp-server",
33
"version": "0.1.1",
4-
"description": "DBJavaGenix MCP Server (Node wrapper around the Python backend). For containerized usage prefer the Docker image.",
4+
"description": "Node.js stdio wrapper for the DBJavaGenix Python MCP server. For containerized usage prefer the Docker image.",
55
"main": "index.js",
66
"bin": {
77
"dbjavagenix-mcp": "./index.js"

‎pyproject.toml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ description = "AI-enhanced Java code generator based on MCP service architecture
99
authors = [
1010
{name = "ZXP", email = "2638265504@qq.com"}
1111
]
12-
readme = "README.md"
13-
license = {text = "MIT"}
12+
readme = "README.md"
13+
# Package metadata remains in this file; requirements-dev.txt supports pip-only workflows.
14+
license = {text = "MIT"}
1415
requires-python = ">=3.11"
1516
keywords = ["mcp", "code-generation", "java", "database", "ai", "skills", "mcp-apps"]
1617
classifiers = [

‎requirements-dev.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# DBJavaGenix 开发环境依赖
2+
# `pyproject.toml` 是规范依赖入口;本文件保留给使用 pip 的开发环境。
23

34
-r requirements.txt
45

0 commit comments

Comments
 (0)