polarisagi-knowledge-base 0.1.0 → 1.0.19

package/README.md

@@ -0,0 +1,36 @@
+# PolarisAGI Knowledge Base MCP
+
+[![npm version](https://img.shields.io/npm/v/polarisagi-knowledge-base.svg)](https://www.npmjs.com/package/polarisagi-knowledge-base)
+
+An official Model Context Protocol (MCP) server plugin for [PolarisAGI](https://polarisagi.online/), enabling agents to securely read local files and directories.
+
+## Features
+
+- **List Files**: Explore directory structures.
+- **Read Content**: Read the textual contents of local files for RAG or context injection.
+- **Sandboxed**: Restricts file reading strictly to a permitted directory via environment variables.
+
+## Architecture
+
+This plugin is a zero-dependency, pure TypeScript implementation utilizing native Node.js `fs` APIs. 
+
+## Usage with PolarisAGI
+
+Configure your AI agent with the following MCP server setting, replacing `/your/allowed/dir` with the absolute path you wish to expose to the agent:
+
+```json
+{
+  "mcpServers": {
+    "polarisagi-knowledge-base": {
+      "command": "npx",
+      "args": ["-y", "polarisagi-knowledge-base@latest"],
+      "env": {
+        "POLARISAGI_KB_ALLOWED_DIR": "/your/allowed/dir"
+      }
+    }
+  }
+}
+```
+
+## Requirements
+- Node.js v18 or newer.

package/dist/index.js

@@ -38,7 +38,7 @@ const readline = __importStar(require("readline"));
 const fs = __importStar(require("fs/promises"));
 const path = __importStar(require("path"));
 // Allowed directory validation
-const allowedDir = process.env.POLARIS_KB_ALLOWED_DIR;
+const allowedDir = process.env.POLARISAGI_KB_ALLOWED_DIR;
 function isPathAllowed(targetPath) {
     if (!allowedDir) {
         return true;
@@ -83,7 +83,7 @@ rl.on('line', async (line) => {
                 protocolVersion: "2024-11-05",
                 capabilities: { tools: {} },
                 serverInfo: {
-                    name: "polaris-knowledge-base-mcp",
+                    name: "polarisagi-knowledge-base-mcp",
                     version: "0.1.0"
                 }
             });
@@ -132,7 +132,7 @@ rl.on('line', async (line) => {
                     return;
                 }
                 if (!isPathAllowed(targetPath)) {
-                    sendResult(id, { isError: true, content: [{ type: "text", text: "path is outside the allowed directory (POLARIS_KB_ALLOWED_DIR)" }] });
+                    sendResult(id, { isError: true, content: [{ type: "text", text: "path is outside the allowed directory (POLARISAGI_KB_ALLOWED_DIR)" }] });
                     return;
                 }
                 try {
@@ -152,7 +152,7 @@ rl.on('line', async (line) => {
                     return;
                 }
                 if (!isPathAllowed(targetPath)) {
-                    sendResult(id, { isError: true, content: [{ type: "text", text: "path is outside the allowed directory (POLARIS_KB_ALLOWED_DIR)" }] });
+                    sendResult(id, { isError: true, content: [{ type: "text", text: "path is outside the allowed directory (POLARISAGI_KB_ALLOWED_DIR)" }] });
                     return;
                 }
                 try {

package/package.json

@@ -1,7 +1,23 @@
 {
   "name": "polarisagi-knowledge-base",
-  "version": "0.1.0",
-  "description": "MCP Plugin for reading local knowledge base files",
+  "version": "1.0.19",
+  "description": "MCP Plugin for reading local knowledge base files, with path sandboxing for RAG",
+  "license": "MIT",
+  "author": {
+    "name": "mrlaoliai",
+    "email": "polarisagi.online@gmail.com",
+    "url": "https://polarisagi.online/"
+  },
+  "homepage": "https://polarisagi.online/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/polarisagi/polarisagi-plugins-official.git",
+    "directory": "plugins/knowledge_base"
+  },
+  "keywords": ["mcp", "knowledge-base", "rag", "file-system", "local-files"],
+  "engines": {
+    "node": ">=18"
+  },
   "files": [
     "dist"
   ],