create-guardio 0.0.2 → 0.0.4

package/index.mjs

@@ -42,7 +42,12 @@ async function main() {
     server: serverConfig,
     plugins: [
       { type: "policy", name: "default", config: { blockedTools: [] } },
-      { type: "policy", name: "example", config: {} },
+      {
+        type: "policy",
+        name: "example",
+        path: "./plugins/example",
+        config: {},
+      },
     ],
   };
 
@@ -55,7 +60,15 @@ async function main() {
     private: true,
     type: "module",
     description: "Guardio-gated MCP server with optional local plugins",
+    scripts: {
+      build: "tsc",
+      guardio: "node bin/guardio.mjs",
+    },
     dependencies: { "@guardiojs/guardio": "*" },
+    devDependencies: {
+      typescript: "^5.6.0",
+      "@types/node": "^22.0.0",
+    },
   };
   await writeFile(
     resolve(guardioPath, "package.json"),
@@ -63,6 +76,23 @@ async function main() {
     "utf-8"
   );
 
+  const tsconfig = {
+    compilerOptions: {
+      target: "ES2022",
+      module: "NodeNext",
+      moduleResolution: "NodeNext",
+      strict: true,
+      skipLibCheck: true,
+      esModuleInterop: true,
+    },
+    include: ["plugins/**/*.ts"],
+  };
+  await writeFile(
+    resolve(guardioPath, "tsconfig.json"),
+    JSON.stringify(tsconfig, null, 2),
+    "utf-8"
+  );
+
   await writeFile(
     resolve(guardioPath, "guardio.config.json"),
     JSON.stringify(config, null, 2),
@@ -91,33 +121,23 @@ process.exit(result.status ?? 1);
   PolicyPluginInterface,
   PolicyRequestContext,
   PolicyResult,
-  PolicyPluginDescriptor,
 } from "@guardiojs/guardio";
 
 /**
- * Example policy plugin: implements Guardio's PolicyPluginInterface.
- * Register in guardio.config.json with: { "type": "policy", "name": "example", "config": {} }
+ * Example policy plugin: implements PolicyPluginInterface.
+ * Reference in guardio.config.json with: { "type": "policy", "name": "example", "path": "./plugins/example" }
+ * Default export must be the plugin instance.
  */
 class ExamplePolicyPlugin implements PolicyPluginInterface {
   readonly name = "example";
 
-  constructor(_config: Record<string, unknown>) {
-    // config from guardio.config.json is passed here
-  }
-
   evaluate(context: PolicyRequestContext): PolicyResult {
     // Example: allow all calls. Replace with your policy logic.
     return "allowed";
   }
 }
 
-const descriptor: PolicyPluginDescriptor = {
-  type: "policy",
-  name: "example",
-  create: (config) => new ExamplePolicyPlugin(config),
-};
-
-export default descriptor;
+export default new ExamplePolicyPlugin();
 `;
 
   await writeFile(
@@ -126,16 +146,15 @@ export default descriptor;
     "utf-8"
   );
 
-  const pluginsReadme = `# Local plugins
-
-Each subdirectory (e.g. example/) is a plugin. Guardio loads \`index.ts\` from each subdirectory.
+  const pluginsReadme = `# Custom plugins (path-based)
 
-Your plugin must implement Guardio's interface and export a descriptor:
+Add a plugin by setting \`path\` in \`guardio.config.json\` to a directory that contains \`index.js\` or \`index.mjs\` (compile from \`index.ts\` with \`npm run build\`).
 
-- Policy: \`PolicyPluginInterface\` and \`PolicyPluginDescriptor\` (type "policy", create() returns instance with evaluate()).
-- Intervention: \`InterventionPluginInterface\` and \`InterventionPluginDescriptor\` (type "intervention", create() returns instance with act()).
+- The directory must have \`index.js\` or \`index.mjs\` whose **default export is the plugin instance** (no descriptor).
+- Policy: implement \`PolicyPluginInterface\` (name, evaluate). Config: \`{ "type": "policy", "name": "my-policy", "path": "./plugins/my-policy" }\`.
+- Intervention: implement \`InterventionPluginInterface\` (name, act). Config: \`{ "type": "intervention", "name": "my-intervention", "path": "./plugins/my-intervention" }\`.
 
-Import types from "@guardiojs/guardio". Add the plugin name to \`guardio.config.json\` in the \`plugins\` array to enable it.
+Import types from "@guardiojs/guardio". See example/ for a policy plugin.
 `;
 
   await writeFile(
@@ -150,6 +169,7 @@ Import types from "@guardiojs/guardio". Add the plugin name to \`guardio.config.
   console.log("\n---\n");
   console.log("Next steps");
   console.log("  cd " + guardioDir + " && npm install");
+  console.log("  npm run build   # compile plugins (index.ts → index.js)");
   console.log("");
   console.log("Add to MCP client");
   console.log("# Copy/paste the shown command\n");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-guardio",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Scaffold a Guardio project",
   "type": "module",
   "bin": {