mcp-efficiency-engine 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/autodocs-sync.yml +49 -0
- package/ARCHITECTURE.md +15 -0
- package/FINAL_USAGE_GUIDE.md +24 -1
- package/README.md +1 -0
- package/package.json +1 -1
|
@@ -30,6 +30,55 @@ jobs:
|
|
|
30
30
|
run: py -3 -m scripts.wiki.wiki_compiler
|
|
31
31
|
shell: pwsh
|
|
32
32
|
|
|
33
|
+
- name: Ensure npm README is updated when package surface changes
|
|
34
|
+
shell: pwsh
|
|
35
|
+
env:
|
|
36
|
+
BASE_SHA: ${{ github.event.pull_request.base.sha }}
|
|
37
|
+
run: |
|
|
38
|
+
$script = @'
|
|
39
|
+
const fs = require("node:fs");
|
|
40
|
+
const { execSync } = require("node:child_process");
|
|
41
|
+
|
|
42
|
+
const baseSha = process.env.BASE_SHA;
|
|
43
|
+
if (!baseSha) {
|
|
44
|
+
console.log("BASE_SHA is not available; skipping npm README check.");
|
|
45
|
+
process.exit(0);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
const pkg = JSON.parse(fs.readFileSync("package.json", "utf8"));
|
|
49
|
+
const publishEntries = (pkg.files || []).map((entry) =>
|
|
50
|
+
entry.startsWith("./") ? entry.slice(2) : entry
|
|
51
|
+
);
|
|
52
|
+
|
|
53
|
+
const changed = execSync("git diff --name-only " + baseSha + "...HEAD", { encoding: "utf8" })
|
|
54
|
+
.split(/\r?\n/)
|
|
55
|
+
.map((line) => line.trim())
|
|
56
|
+
.filter(Boolean);
|
|
57
|
+
|
|
58
|
+
const readmeChanged = changed.includes("README.md");
|
|
59
|
+
const isNpmRelevant = (file) =>
|
|
60
|
+
file === "package.json" ||
|
|
61
|
+
file === "package-lock.json" ||
|
|
62
|
+
publishEntries.some((entry) => (entry.endsWith("/") ? file.startsWith(entry) : file === entry));
|
|
63
|
+
|
|
64
|
+
const npmRelevantChanges = changed.filter((file) => file !== "README.md" && isNpmRelevant(file));
|
|
65
|
+
if (npmRelevantChanges.length > 0 && !readmeChanged) {
|
|
66
|
+
console.error("Detected npm-impacting changes without README.md update.");
|
|
67
|
+
console.error("npm-impacting files:");
|
|
68
|
+
for (const file of npmRelevantChanges) console.error("- " + file);
|
|
69
|
+
console.error("Please update README.md (npm docs) in the same PR.");
|
|
70
|
+
process.exit(1);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
if (npmRelevantChanges.length > 0) {
|
|
74
|
+
console.log("npm-impacting changes detected and README.md was updated.");
|
|
75
|
+
} else {
|
|
76
|
+
console.log("No npm-impacting changes detected.");
|
|
77
|
+
}
|
|
78
|
+
'@
|
|
79
|
+
|
|
80
|
+
node -e $script
|
|
81
|
+
|
|
33
82
|
- name: Validate generated artifacts are committed
|
|
34
83
|
shell: pwsh
|
|
35
84
|
run: |
|
package/ARCHITECTURE.md
CHANGED
|
@@ -7,21 +7,27 @@ flowchart TD
|
|
|
7
7
|
O --> A[Agents Layer]
|
|
8
8
|
|
|
9
9
|
A --> DEV[backend]
|
|
10
|
+
A --> FE[frontend-agent]
|
|
10
11
|
A --> LEG[legacy]
|
|
11
12
|
A --> DBA[dba]
|
|
13
|
+
A --> UX[ux-ui]
|
|
12
14
|
A --> RAG[rag-local]
|
|
13
15
|
A --> AZ[rag-azure]
|
|
14
16
|
A --> IOT[iot]
|
|
15
17
|
A --> COM[community-manager]
|
|
18
|
+
A --> WIKI[wiki-agent]
|
|
16
19
|
A --> SNAP[snapshot]
|
|
17
20
|
|
|
18
21
|
DEV --> TS[Token Saver Policy]
|
|
22
|
+
FE --> TS
|
|
19
23
|
LEG --> TS
|
|
20
24
|
DBA --> TS
|
|
25
|
+
UX --> TS
|
|
21
26
|
RAG --> TS
|
|
22
27
|
AZ --> TS
|
|
23
28
|
IOT --> TS
|
|
24
29
|
COM --> TS
|
|
30
|
+
WIKI --> TS
|
|
25
31
|
SNAP --> TS
|
|
26
32
|
|
|
27
33
|
TS --> CG[CodeGraph]
|
|
@@ -55,3 +61,12 @@ Token Saver optimiza qué contexto se usa.
|
|
|
55
61
|
Routing decide qué motor se usa.
|
|
56
62
|
Observability mide si todo funciona.
|
|
57
63
|
```
|
|
64
|
+
|
|
65
|
+
## Routing base (resumen)
|
|
66
|
+
|
|
67
|
+
- `backend` y `frontend-agent` -> `CodeGraph`
|
|
68
|
+
- `legacy` -> `GitNexus`
|
|
69
|
+
- `dba`, `ux-ui`, `rag-local`, `community-manager` -> `Graphify`
|
|
70
|
+
- `rag-azure` -> `Azure RAG Builder`
|
|
71
|
+
- `wiki-agent` -> `CodeGraph` (fallback `Graphify`)
|
|
72
|
+
- `snapshot` -> `Repomix`
|
package/FINAL_USAGE_GUIDE.md
CHANGED
|
@@ -85,7 +85,30 @@ Esto significa:
|
|
|
85
85
|
- las fuentes se conservan cuando sean obligatorias,
|
|
86
86
|
- el sistema solo aumenta detalle si el usuario o el caso lo requiere.
|
|
87
87
|
|
|
88
|
-
## 7.
|
|
88
|
+
## 7. Instalación desde npm (rápido)
|
|
89
|
+
|
|
90
|
+
Instalación recomendada en proyecto host:
|
|
91
|
+
|
|
92
|
+
```powershell
|
|
93
|
+
npm install mcp-efficiency-engine
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Si el entorno bloquea scripts de npm (`allow-scripts`), ejecutar manualmente:
|
|
97
|
+
|
|
98
|
+
```powershell
|
|
99
|
+
npx mcp-efficiency-engine install
|
|
100
|
+
npx mcp-efficiency-engine validate -PortableMode
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Validación de contenido publicado en npm:
|
|
104
|
+
|
|
105
|
+
```powershell
|
|
106
|
+
npm pack --dry-run
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Debe listar, como mínimo, `bin/`, `scripts/`, `.github/`, `README.md`, `AGENTS.md`, `ARCHITECTURE.md` y `FINAL_USAGE_GUIDE.md`.
|
|
110
|
+
|
|
111
|
+
## 8. Telemetry Engine
|
|
89
112
|
|
|
90
113
|
El sistema incluye un engine de telemetría desacoplado con collector único.
|
|
91
114
|
|
package/README.md
CHANGED
|
@@ -118,6 +118,7 @@ Contrato global en `AGENTS.md`:
|
|
|
118
118
|
- `rag-azure` -> `Azure RAG Builder`
|
|
119
119
|
- `iot` -> `GitNexus/CodeGraph + Graphify`
|
|
120
120
|
- `community-manager` -> `Graphify`
|
|
121
|
+
- `wiki-agent` -> `CodeGraph` (fallback `Graphify`)
|
|
121
122
|
- `snapshot` -> `Repomix`
|
|
122
123
|
|
|
123
124
|
## Motores Y Herramientas
|