@agentlighthouse/core 0.1.0-alpha.0

package/dist/scoring/model.js

@@ -0,0 +1,109 @@
+export const scoringModelVersion = "0.1.0";
+export const severityWeights = {
+    critical: 20,
+    high: 10,
+    medium: 5,
+    low: 2,
+    info: 0
+};
+const subscoreDefinitions = [
+    {
+        id: "agent_instructions",
+        label: "Agent Instructions",
+        categories: ["agent_instructions"]
+    },
+    {
+        id: "documentation",
+        label: "Documentation",
+        categories: ["documentation", "repo_structure"]
+    },
+    {
+        id: "api_and_tooling",
+        label: "API & Tooling",
+        categories: ["api_schema", "mcp_tools", "setup_and_tests"]
+    },
+    {
+        id: "examples_and_tasks",
+        label: "Examples & Tasks",
+        categories: ["examples", "task_benchmarks"]
+    },
+    {
+        id: "security_and_privacy",
+        label: "Security & Privacy",
+        categories: ["security_and_privacy"]
+    },
+    {
+        id: "freshness_and_consistency",
+        label: "Freshness & Consistency",
+        categories: ["freshness_and_consistency"]
+    }
+];
+export class TransparentScoringModel {
+    id = "transparent-severity-scoring";
+    version = scoringModelVersion;
+    score(findings, _signals) {
+        void _signals;
+        const score = clampScore(100 - totalPenalty(findings));
+        const subscores = subscoreDefinitions.map((definition) => {
+            const relevantFindings = findings.filter((finding) => definition.categories.some((category) => category === finding.category));
+            return {
+                id: definition.id,
+                label: definition.label,
+                score: clampScore(100 - totalPenalty(relevantFindings)),
+                findingsCount: relevantFindings.filter((finding) => finding.severity !== "info").length
+            };
+        });
+        return {
+            scoringModelVersion,
+            score,
+            summary: summarize(score, findings),
+            subscores,
+            recommendations: recommendedActions(findings)
+        };
+    }
+}
+function totalPenalty(findings) {
+    return findings.reduce((total, finding) => total + severityWeights[finding.severity], 0);
+}
+function clampScore(value) {
+    return Math.max(0, Math.min(100, value));
+}
+function summarize(score, findings) {
+    const blocking = findings.filter((finding) => ["critical", "high"].includes(finding.severity));
+    if (score >= 85) {
+        return `Strong agent-readiness with ${blocking.length} high-priority issue(s) remaining.`;
+    }
+    if (score >= 65) {
+        return `Useful foundation, but ${blocking.length} high-priority readiness issue(s) should be fixed.`;
+    }
+    return `Agent-readiness needs focused work before agents can reliably use this project.`;
+}
+function recommendedActions(findings) {
+    const actions = [];
+    const ids = new Set(findings.map((finding) => finding.id));
+    if (ids.has("agent-instructions.missing-agents-md") || ids.has("llms.missing")) {
+        actions.push("Run: agentlighthouse init .");
+    }
+    if ([...ids].some((id) => id.startsWith("setup."))) {
+        actions.push("Add or document setup, test, lint, and typecheck commands.");
+    }
+    if ([...ids].some((id) => id.startsWith("docs."))) {
+        actions.push("Improve README and docs so agents can find quickstart, install, and examples.");
+    }
+    if ([...ids].some((id) => id.startsWith("benchmarks.") || id.startsWith("TASK_"))) {
+        actions.push("Add task benchmarks for the top developer workflows agents should complete.");
+    }
+    if ([...ids].some((id) => id.startsWith("OPENAPI_"))) {
+        actions.push("Improve OpenAPI operation descriptions, examples, auth, and error responses.");
+    }
+    if ([...ids].some((id) => id.startsWith("MCP_"))) {
+        actions.push("Clarify MCP tool names, descriptions, schemas, examples, and safety notes.");
+    }
+    if ([...ids].some((id) => id.startsWith("COMMAND_"))) {
+        actions.push("Use opt-in command probes in trusted environments to verify setup and tests.");
+    }
+    if ([...ids].some((id) => id.startsWith("security."))) {
+        actions.push("Document secret-handling and privacy rules for agent workflows.");
+    }
+    return actions.slice(0, 5);
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@agentlighthouse/core",
+  "version": "0.1.0-alpha.0",
+  "description": "Core scanner, schemas, scoring, and generators for AgentLighthouse.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PainDeMie64/agentlighthouse.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/PainDeMie64/agentlighthouse#readme",
+  "bugs": {
+    "url": "https://github.com/PainDeMie64/agentlighthouse/issues"
+  },
+  "keywords": [
+    "agent-readiness",
+    "ai-agents",
+    "openapi",
+    "mcp",
+    "ci",
+    "sarif"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "!dist/__tests__",
+    "!dist/.tsbuildinfo",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "yaml": "^2.9.0",
+    "zod": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.0"
+  }
+}