open-edison 0.1.15__py3-none-any.whl → 0.1.16__py3-none-any.whl

{open_edison-0.1.15.dist-info → open_edison-0.1.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-edison
-Version: 0.1.15
+Version: 0.1.16
 Summary: Open-source MCP security, aggregation, and monitoring. Single-user, self-hosted MCP proxy.
 Author-email: Hugo Berg <hugo@edison.watch>
 License-File: LICENSE
@@ -25,12 +25,22 @@ Requires-Dist: pytest>=8.3.3; extra == 'dev'
 Requires-Dist: ruff>=0.12.3; extra == 'dev'
 Description-Content-Type: text/markdown
 
-# Open Edison
+# OpenEdison
 
 Open-source MCP security gateway that prevents data exfiltration—via direct access or tool chaining—with full monitoring for local single‑user deployments. Provides core functionality of <https://edison.watch> for local, single-user use.
 
+Just want to run it?
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/Edison-Watch/open-edison/main/curl_pipe_bash.sh | bash
+```
+
 Run locally with uvx: `uvx open-edison --config-dir ~/edison-config`
 
+<div align="center">
+  <h2>📧 Interested in connecting AI to your business software with proper access controls? <a href="mailto:hello@edison.watch">Contact us</a> to discuss.</h2>
+</div>
+
 ## Features
 
 - **Single-user MCP proxy** - No multi-user complexity, just a simple proxy for your MCP servers
@@ -65,6 +75,25 @@ open-edison run --config-dir ~/edison-config
 OPEN_EDISON_CONFIG_DIR=~/edison-config open-edison run
 ```
 
+### Run with Docker
+
+There is a dockerfile for simple local setup.
+
+```bash
+# Single-line:
+git clone https://github.com/GatlingX/open-edison.git && cd open-edison && make docker_run
+
+# Or
+# Clone repo
+git clone https://github.com/GatlingX/open-edison.git
+# Enter repo
+cd open-edison
+# Build and run
+make docker_run
+```
+
+The MCP server will be available at `http://localhost:3000` and the api + frontend at `http://localhost:3001`.
+
 ### Run from source
 
 1. Clone the repository:
@@ -74,33 +103,26 @@ git clone https://github.com/GatlingX/open-edison.git
 cd open-edison
 ```
 
-2. Set up the project:
+1. Set up the project:
 
 ```bash
 make setup
 ```
 
-3. Edit `config.json` to configure your MCP servers:
+1. Edit `config.json` to configure your MCP servers. See the full file: [config.json](config.json), it looks like:
 
 ```json
 {
-  "server": {
-    "host": "localhost",
-    "port": 3000,
-    "api_key": "your-secure-api-key"
-  },
+  "server": { "host": "0.0.0.0", "port": 3000, "api_key": "..." },
+  "logging": { "level": "INFO", "database_path": "sessions.db" },
   "mcp_servers": [
-    {
-      "name": "filesystem",
-      "command": "uvx",
-      "args": ["mcp-server-filesystem", "/path/to/directory"],
-      "enabled": true
-    }
+    { "name": "filesystem", "command": "npx", "args": ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"], "enabled": true },
+    { "name": "github", "enabled": false, "env": { "GITHUB_PERSONAL_ACCESS_TOKEN": "..." } }
   ]
 }
 ```
 
-4. Run the server:
+1. Run the server:
 
 ```bash
 make run
@@ -110,15 +132,6 @@ open-edison run
 
 The server will be available at `http://localhost:3000`.
 
-### Run with Docker
-
-```bash
-# After cloning the repo
-make docker_run
-```
-
-The MCP server will be available at `http://localhost:3000` and the api + frontend at `http://localhost:3001`.
-
 ## MCP Connection
 
 Connect any MCP client to Open Edison:
@@ -144,64 +157,28 @@ Or add to your MCP client config:
 
 ### API Endpoints
 
-Api is on port 3001 (or configured MCP server port + 1).
-
-- `GET /health` - Health check
-- `GET /mcp/status` - Get status of configured MCP servers
-- `POST /mcp/{server_name}/start` - Start a specific MCP server
-- `POST /mcp/{server_name}/stop` - Stop a specific MCP server
-- `POST /mcp/call` - Proxy MCP calls to running servers
-- `GET /sessions` - Get session logs (coming soon)
-
-All endpoints except `/health` require the `Authorization: Bearer <api_key>` header.
+See [API Reference](docs/quick-reference/api_reference.md) for full API documentation.
 
 ## Development
 
-```bash
-# Install dependencies
-make sync
-
-# Run with auto-reload
-make dev
+### Setup
 
-# Run tests
-make test
+Setup from source as above.
 
-# Lint code
-make lint
+### Run
 
-# Format code
-make format
-```
-
-### Website (Sessions Dashboard)
-
-A minimal React + Vite frontend is included at `open-edison/frontend/`.
-
-Run it with a single command from the repo root or via the CLI:
+Server doesn't have any auto-reload at the moment, so you'll need to run & ctrl-c this during development.
 
 ```bash
-make website
-# or
-open-edison website
+make run
 ```
 
-This will install frontend deps (first run) and start the dev server. Open the URL shown (typically `http://localhost:5173` or `5174`).
-
-Notes:
+### Tests/code quality
 
-- The dashboard reads session data directly from the SQLite database `edison.db` in the repo root via sql.js.
-- The Configs tab provides JSON editors (with syntax highlighting) for `config.json`, `tool_permissions.json`, `resource_permissions.json`, and `prompt_permissions.json`.
-- You can Save changes directly while the dev server is running; writes are constrained to the project root.
-
-## Docker
+We expect `make ci` to return cleanly.
 
 ```bash
-# Build Docker image
-make docker_build
-
-# Run in Docker
-make docker_run
+make ci
 ```
 
 ## Configuration
@@ -230,80 +207,48 @@ Open Edison includes a comprehensive security monitoring system that tracks the
 2. **Untrusted content exposure** - Exposure to external/web content  
 3. **External communication** - Ability to write/send data externally
 
-The system monitors these risks across **tools**, **resources**, and **prompts** using separate configuration files.
+The configuration allows you to classify these risks across **tools**, **resources**, and **prompts** using separate configuration files.
+
+In addition to trifecta, we track Access Control Level (ACL) for each tool call,
+that is, each tool has an ACL level (one of PUBLIC, PRIVATE, or SECRET), and we track the highest ACL level for each session.
+If a write operation is attempted to a lower ACL level, it is blocked.
 
 ### Tool Permissions (`tool_permissions.json`)
 
-Defines security classifications for MCP tools. Each tool is classified with three boolean flags:
+Defines security classifications for MCP tools. See full file: [tool_permissions.json](tool_permissions.json), it looks like:
 
 ```json
 {
-  "filesystem_read_file": {
-    "write_operation": false,
-    "read_private_data": true,
-    "read_untrusted_public_data": false
+  "_metadata": { "last_updated": "2025-08-07" },
+  "builtin": {
+    "get_security_status": { "enabled": true, "write_operation": false, "read_private_data": false, "read_untrusted_public_data": false, "acl": "PUBLIC" }
   },
-  "sqlite_create_record": {
-    "write_operation": true,
-    "read_private_data": true,
-    "read_untrusted_public_data": false
+  "filesystem": {
+    "read_file": { "enabled": true, "write_operation": false, "read_private_data": true, "read_untrusted_public_data": false, "acl": "PRIVATE" },
+    "write_file": { "enabled": true, "write_operation": true, "read_private_data": true, "read_untrusted_public_data": false, "acl": "PRIVATE" }
   }
 }
 ```
 
 ### Resource Permissions (`resource_permissions.json`)
 
-Defines security classifications for resource access patterns. Currently empty - add classifications as needed:
+Defines security classifications for resource access patterns. See full file: [resource_permissions.json](resource_permissions.json), it looks like:
 
 ```json
 {
-  "_metadata": {
-    "description": "Resource security classifications for Open Edison data access tracker",
-    "last_updated": "2025-08-07"
-  },
-  "file:*": {
-    "write_operation": false,
-    "read_private_data": true,
-    "read_untrusted_public_data": false
-  },
-  "http:*": {
-    "write_operation": false,
-    "read_private_data": false,
-    "read_untrusted_public_data": true
-  },
-  "database:*": {
-    "write_operation": false,
-    "read_private_data": true,
-    "read_untrusted_public_data": false
-  }
+  "_metadata": { "last_updated": "2025-08-07" },
+  "builtin": { "config://app": { "enabled": true, "write_operation": false, "read_private_data": false, "read_untrusted_public_data": false } }
 }
 ```
 
 ### Prompt Permissions (`prompt_permissions.json`)
 
-Defines security classifications for prompt types. Currently empty - add classifications as needed:
+Defines security classifications for prompt types. See full file: [prompt_permissions.json](prompt_permissions.json), it looks like:
 
 ```json
 {
-  "_metadata": {
-    "description": "Prompt security classifications for Open Edison data access tracker", 
-    "last_updated": "2025-08-07"
-  },
-  "system": {
-    "write_operation": false,
-    "read_private_data": false,
-    "read_untrusted_public_data": false
-  },
-  "external_prompt": {
-    "write_operation": false,
-    "read_private_data": false,
-    "read_untrusted_public_data": true
-  },
-  "prompt:file:*": {
-    "write_operation": false,
-    "read_private_data": true,
-    "read_untrusted_public_data": false
-  }
+  "_metadata": { "last_updated": "2025-08-07" },
+  "builtin": { "summarize_text": { "enabled": true, "write_operation": false, "read_private_data": false, "read_untrusted_public_data": false } }
 }
 ```
 

{open_edison-0.1.15.dist-info → open_edison-0.1.16.dist-info}/RECORD

@@ -10,9 +10,9 @@ src/frontend_dist/index.html,sha256=Y4ZfK2hzHsfCiqh7Z7dzajTdojVjKCC5YL4JxdXeig4,
 src/frontend_dist/assets/index-_NTxjOfh.js,sha256=KetbIa26YNfMP_SwWa04fCr9jGNnoPeZsA41-Oxgx6w,236658
 src/frontend_dist/assets/index-h6k8aL6h.css,sha256=Lq5FK1bsPMR67cAwD_-fMvWqKbo_IyraMSKndoQf8i8,13875
 src/middleware/data_access_tracker.py,sha256=RZh1RCBYDEbvVIJPkDUz0bfLmK-xYIdV0lGbIxbJYc0,25966
-src/middleware/session_tracking.py,sha256=mApPfJLjHfiSf5CjMeq-IWqjKFsjvWgBgGrgy5GJWa0,20043
-open_edison-0.1.15.dist-info/METADATA,sha256=hiQZYgHCzeahyIB26lrwRaQI_QbjCUJ7MxaG90aX62U,8967
-open_edison-0.1.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-open_edison-0.1.15.dist-info/entry_points.txt,sha256=qNAkJcnoTXRhj8J--3PDmXz_TQKdB8H_0C9wiCtDIyA,72
-open_edison-0.1.15.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-open_edison-0.1.15.dist-info/RECORD,,
+src/middleware/session_tracking.py,sha256=cXuOdJy3Lt7mw_mbtWRVKN7hUTMFJkudaCzPEG_cB5c,20039
+open_edison-0.1.16.dist-info/METADATA,sha256=M_F6kqHCZMyV4tOl8rIRgDlSMAfTxPkI0Sw_U8aJJoU,8611
+open_edison-0.1.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+open_edison-0.1.16.dist-info/entry_points.txt,sha256=qNAkJcnoTXRhj8J--3PDmXz_TQKdB8H_0C9wiCtDIyA,72
+open_edison-0.1.16.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+open_edison-0.1.16.dist-info/RECORD,,

src/middleware/session_tracking.py

@@ -296,7 +296,7 @@ class SessionTrackingMiddleware(Middleware):
 
         assert session.data_access_tracker is not None
         log.debug(f"🔍 Analyzing tool {context.message.name} for security implications")
-        _ = session.data_access_tracker.add_tool_call(context.message.name)
+        session.data_access_tracker.add_tool_call(context.message.name)
         # Telemetry: record tool call
         record_tool_call(context.message.name)