open-edison 0.1.10__py3-none-any.whl

open_edison-0.1.10.dist-info/METADATA

@@ -0,0 +1,332 @@
+Metadata-Version: 2.4
+Name: open-edison
+Version: 0.1.10
+Summary: Open-source MCP security, aggregation, and monitoring. Single-user, self-hosted MCP proxy.
+Author-email: Hugo Berg <hugo@edison.watch>
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: aiohttp>=3.12.14
+Requires-Dist: aiosqlite>=0.20.0
+Requires-Dist: fastapi>=0.116.1
+Requires-Dist: fastmcp>=2.10.5
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: sqlalchemy>=2.0.41
+Requires-Dist: starlette>=0.47.1
+Requires-Dist: uvicorn>=0.35.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=1.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.3; extra == 'dev'
+Requires-Dist: ruff>=0.12.3; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Open Edison
+
+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.
+
+Run locally with uvx: `uvx open-edison --config-dir ~/edison-config`
+
+## Features
+
+- **Single-user MCP proxy** - No multi-user complexity, just a simple proxy for your MCP servers
+- **JSON configuration** - Easy to configure and manage your MCP servers
+- **Simple local frontend** - Track and monitor your MCP interactions, servers, and sessions.
+- **Session tracking** - Track and monitor your MCP interactions
+- **Simple API** - REST API for managing MCP servers and proxying requests
+- **Docker support** - Run in a container for easy deployment
+
+## Quick Start
+
+### Install from PyPI
+
+#### Prerequisites
+
+- Pipx/uvx
+
+```bash
+# Using uvx
+uvx open-edison --help
+
+# Using pipx
+pipx install open-edison
+open-edison --help
+```
+
+Run with a custom config directory:
+
+```bash
+open-edison run --config-dir ~/edison-config
+# or via environment variable
+OPEN_EDISON_CONFIG_DIR=~/edison-config open-edison run
+```
+
+### Run from source
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/GatlingX/open-edison.git
+cd open-edison
+```
+
+2. Set up the project:
+
+```bash
+make setup
+```
+
+3. Edit `config.json` to configure your MCP servers:
+
+```json
+{
+  "server": {
+    "host": "localhost",
+    "port": 3000,
+    "api_key": "your-secure-api-key"
+  },
+  "mcp_servers": [
+    {
+      "name": "filesystem",
+      "command": "uvx",
+      "args": ["mcp-server-filesystem", "/path/to/directory"],
+      "enabled": true
+    }
+  ]
+}
+```
+
+4. Run the server:
+
+```bash
+make run
+# or, from the installed package
+open-edison run
+```
+
+The server will be available at `http://localhost:3000`.
+
+### Run with Docker
+
+```bash
+# After cloning the repo
+make run_docker
+```
+
+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:
+
+```bash
+npx -y mcp-remote http://localhost:3000/mcp/ --http-only --header "Authorization: Bearer your-api-key"
+```
+
+Or add to your MCP client config:
+
+```json
+{
+  "mcpServers": {
+    "open-edison": {
+      "command": "npx",
+      "args": ["-y", "mcp-remote", "http://localhost:3000/mcp/", "--http-only", "--header", "Authorization: Bearer your-api-key"]
+    }
+  }
+}
+```
+
+## Usage
+
+### 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.
+
+## Development
+
+```bash
+# Install dependencies
+make sync
+
+# Run with auto-reload
+make dev
+
+# Run tests
+make test
+
+# Lint code
+make lint
+
+# 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:
+
+```bash
+make website
+# or
+open-edison website
+```
+
+This will install frontend deps (first run) and start the dev server. Open the URL shown (typically `http://localhost:5173` or `5174`).
+
+Notes:
+
+- 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
+
+```bash
+# Build Docker image
+make docker_build
+
+# Run in Docker
+make docker_run
+```
+
+## Configuration
+
+The `config.json` file contains all configuration:
+
+- `server.host` - Server host (default: localhost)
+- `server.port` - Server port (default: 3000)
+- `server.api_key` - API key for authentication
+- `logging.level` - Log level (DEBUG, INFO, WARNING, ERROR)
+- `mcp_servers` - Array of MCP server configurations
+
+Each MCP server configuration includes:
+
+- `name` - Unique name for the server
+- `command` - Command to run the MCP server
+- `args` - Arguments for the command
+- `env` - Environment variables (optional)
+- `enabled` - Whether to auto-start this server
+
+## Security & Permissions System
+
+Open Edison includes a comprehensive security monitoring system that tracks the "lethal trifecta" of AI agent risks:
+
+1. **Private data access** - Access to sensitive local files/data
+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.
+
+### Tool Permissions (`tool_permissions.json`)
+
+Defines security classifications for MCP tools. Each tool is classified with three boolean flags:
+
+```json
+{
+  "filesystem_read_file": {
+    "write_operation": false,
+    "read_private_data": true,
+    "read_untrusted_public_data": false
+  },
+  "sqlite_create_record": {
+    "write_operation": true,
+    "read_private_data": true,
+    "read_untrusted_public_data": false
+  }
+}
+```
+
+### Resource Permissions (`resource_permissions.json`)
+
+Defines security classifications for resource access patterns. Currently empty - add classifications as needed:
+
+```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
+  }
+}
+```
+
+### Prompt Permissions (`prompt_permissions.json`)
+
+Defines security classifications for prompt types. Currently empty - add classifications as needed:
+
+```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
+  }
+}
+```
+
+### Wildcard Patterns
+
+All permission types support wildcard patterns:
+
+- **Tools**: `server_name/*` (e.g., `filesystem/*` matches all filesystem tools)
+- **Resources**: `scheme:*` (e.g., `file:*` matches all file resources)  
+- **Prompts**: `type:*` (e.g., `template:*` matches all template prompts)
+
+### Security Monitoring
+
+**All items must be explicitly configured** - unknown tools/resources/prompts will be rejected for security.
+
+Use the `get_security_status` tool to monitor your session's current risk level and see which capabilities have been accessed. When the lethal trifecta is achieved (all three risk flags set), further potentially dangerous operations are blocked.
+
+## Documentation
+
+📚 **Complete documentation available in [`docs/`](docs/)**
+
+- **[Getting Started](docs/quick-reference/config_quick_start.md)** - Quick setup guide
+- **[Configuration](docs/core/configuration.md)** - Complete configuration reference
+- **[API Reference](docs/quick-reference/api_reference.md)** - REST API documentation
+- **[Development Guide](docs/development/development_guide.md)** - Contributing and development
+
+## License
+
+GPL-3.0 License - see [LICENSE](LICENSE) for details.

open_edison-0.1.10.dist-info/RECORD

@@ -0,0 +1,17 @@
+src/__init__.py,sha256=QWeZdjAm2D2B0eWhd8m2-DPpWvIP26KcNJxwEoU1oEQ,254
+src/__main__.py,sha256=kQsaVyzRa_ESC57JpKDSQJAHExuXme0rM5beJsYxFeA,161
+src/cli.py,sha256=ketV-e9oQMVlLBjZR7YbK33XkEfqxPyzWqYkS1YwqYc,9968
+src/config.py,sha256=klWrNycPxzVt9wPhiNbjXMkB4bHZplenfWDx-3UtQac,7120
+src/mcp_manager.py,sha256=VpRdVMy1WLegC-gBnyTcBMcKzQsdIn4JIWuHf7Q40hg,4442
+src/server.py,sha256=7hwhutP0qZ_mjZfs6jcB-UNe_VyibFKl6hPyHWoa-ns,22896
+src/single_user_mcp.py,sha256=ue5UnC0nfmuLR4z87904WqH7B-0FaACFDWaBNNL7hXE,15259
+src/frontend_dist/index.html,sha256=CL9uiDUygp5_5_VpsW4WMgYFsMAfVSueYit_vFgX0Qo,673
+src/frontend_dist/assets/index-CKkid2y-.js,sha256=zaZ7j0nyGkywXAMuCrhZLaSOVqLu7JkQG3wE_8QiFT4,219537
+src/frontend_dist/assets/index-CRxojymD.css,sha256=kANM9zPkbS5aLrPzePZK0Fbt580I6kNnyFjkFH13HtA,11383
+src/middleware/data_access_tracker.py,sha256=JkwZdtMCiVU7JJZDd-GhlowW2szMDnXrD95nhxQVXR4,21165
+src/middleware/session_tracking.py,sha256=rWZh4UBQbqzPh4p6vxdtRwEC1uzq93yjzxcI9LnlRkA,19307
+open_edison-0.1.10.dist-info/METADATA,sha256=15i5EIVlRNQtBIs3RJTTwiTPXEfF2FYy2a3W2KoBN3g,8834
+open_edison-0.1.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+open_edison-0.1.10.dist-info/entry_points.txt,sha256=qNAkJcnoTXRhj8J--3PDmXz_TQKdB8H_0C9wiCtDIyA,72
+open_edison-0.1.10.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+open_edison-0.1.10.dist-info/RECORD,,

open_edison-0.1.10.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

open_edison-0.1.10.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+open-edison = src.cli:main
+open_edison = src.cli:main