@heimdall-ai/heimdall 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Heimdall AI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,471 @@
+# Heimdall MCP Server
+
+A TypeScript MCP server providing **sandboxed Python and Bash execution** using [Pyodide](https://pyodide.org/) (Python compiled to WebAssembly) and [just-bash](https://github.com/vercel-labs/just-bash).
+
+> Named after the Norse god who guards the Bifröst bridge, Heimdall watches over code execution with security and vigilance.
+
+## Features
+
+- 🔒 **Secure Sandbox**: Python code runs in an isolated WebAssembly environment
+- 🐚 **Bash Execution**: Run bash commands with 50+ built-in tools (grep, sed, awk, jq, find, etc.)
+- 📁 **Virtual Filesystem**: Read, write, list, and delete files in a persistent workspace
+- 📦 **Package Management**: Install pure Python packages via micropip
+- 🔄 **Session Persistence**: Workspace files persist across executions
+- ⚡ **Native Integration**: Direct Pyodide and just-bash integration (no subprocess bridge)
+- 🤝 **Interoperability**: Bash and Python share the same workspace filesystem
+
+## Architecture
+
+```
+┌──────────────────────────────────────────────────────────┐
+│                   MCP Client (Cursor)                    │
+└────────────────────┬─────────────────────────────────────┘
+                     │ MCP Protocol (stdio)
+┌────────────────────▼─────────────────────────────────────┐
+│           TypeScript MCP Server (Node.js)                │
+│  • @modelcontextprotocol/sdk                             │
+│  • PyodideManager + BashManager                          │
+│  • Virtual FS ↔ Host FS sync                             │
+├──────────────────────┬──────────────────┬────────────────┤
+│   Pyodide (WASM)     │  just-bash (TS)  │  Shared FS     │
+│  • Python runtime    │  • Bash simulator│  • ./workspace │
+│  • /workspace mount  │  • 50+ commands  │  • Persistence │
+└──────────────────────┴──────────────────┴────────────────┘
+```
+
+## Prerequisites
+
+- **Node.js** >= 18.0.0
+
+## Installation
+
+```bash
+npm install
+```
+
+## Usage
+
+### Development (with hot reload)
+
+```bash
+npm run dev
+```
+
+### Production
+
+```bash
+npm run build
+npm start
+```
+
+### Cursor MCP Configuration
+
+Add to your Cursor settings (`~/.cursor/mcp.json` or workspace `.cursor/mcp.json`):
+
+```json
+{
+  "mcpServers": {
+    "heimdall": {
+      "command": "node",
+      "args": ["dist/server.js"],
+      "cwd": "/path/to/heimdall"
+    }
+  }
+}
+```
+
+Or for development with `tsx`:
+
+```json
+{
+  "mcpServers": {
+    "heimdall": {
+      "command": "npx",
+      "args": ["tsx", "src/server.ts"],
+      "cwd": "/path/to/heimdall"
+    }
+  }
+}
+```
+
+## Available Tools
+
+### `execute_bash`
+
+Execute bash commands in the Heimdall environment using just-bash.
+
+**Features:**
+- 50+ built-in commands: grep, sed, awk, find, jq, curl, tar, etc.
+- Pipes and redirections: `|`, `>`, `>>`, `2>`, `2>&1`
+- Variables, loops, conditionals, and functions
+- File operations: ls, cat, cp, mv, rm, mkdir, etc.
+- Text processing: grep, sed, awk, cut, sort, uniq, wc, etc.
+- Data tools: jq (JSON), sqlite3 (SQLite), xan (CSV), yq (YAML)
+
+**Security:**
+- No real processes spawned (TypeScript simulation)
+- Execution limits prevent infinite loops
+- Network access disabled by default
+- Filesystem limited to workspace directory
+
+```typescript
+// Input
+{
+  command: string;  // Bash command to execute
+  cwd?: string;     // Working directory (relative to /workspace)
+}
+
+// Output
+{
+  stdout: string;
+  stderr: string;
+  exitCode: number;
+}
+```
+
+**Examples:**
+
+```bash
+# Find Python files
+find . -name "*.py" -type f
+
+# Process text files
+cat data.txt | grep "pattern" | wc -l
+
+# JSON processing
+cat data.json | jq '.users[] | {name, email}'
+
+# Multiple commands
+ls -la && cat README.md | head -10
+
+# Text processing pipeline
+grep -r "TODO" src/ | sort | uniq
+```
+
+### `execute_python`
+
+Execute Python code in the sandbox. Packages are **auto-detected** from imports.
+
+**Note:** Network access is NOT available - Pyodide runs in WebAssembly which provides a security boundary that prevents network requests.
+
+```typescript
+// Input
+{
+  code: string;           // Python code to execute
+  packages?: string[];    // Optional additional packages (auto-detection handles most cases)
+}
+
+// Output
+{
+  success: boolean;
+  stdout: string;
+  stderr: string;
+  result: string | null;  // Last expression value
+  error: string | null;
+}
+```
+
+**Example:**
+```python
+# Packages are auto-detected - no need to specify numpy/pandas!
+import numpy as np
+import pandas as pd
+
+data = np.array([1, 2, 3, 4, 5])
+df = pd.DataFrame({'values': data, 'squared': data ** 2})
+print(df)
+```
+
+### `install_packages`
+
+Install Python packages via micropip.
+
+```typescript
+// Input
+{
+  packages: string[];  // Package names to install
+}
+
+// Output
+{
+  results: Array<{
+    package: string;
+    success: boolean;
+    error: string | null;
+  }>;
+}
+```
+
+### `write_file`
+
+Write content to a file in the workspace.
+
+```typescript
+// Input
+{
+  path: string;     // File path relative to workspace
+  content: string;  // Content to write
+}
+```
+
+### `read_file`
+
+Read a file from the workspace.
+
+```typescript
+// Input
+{
+  path: string;  // File path relative to workspace
+}
+```
+
+### `list_files`
+
+List files in a directory.
+
+```typescript
+// Input
+{
+  path?: string;  // Directory path (empty for root)
+}
+
+// Output
+{
+  files: Array<{
+    name: string;
+    isDirectory: boolean;
+    size: number;
+  }>;
+}
+```
+
+### `delete_file`
+
+Delete a file or empty directory.
+
+```typescript
+// Input
+{
+  path: string;  // File or directory path
+}
+```
+
+## Available Resources
+
+| URI | Description |
+|-----|-------------|
+| `workspace://files` | Tree listing of workspace contents |
+| `workspace://file/{path}` | Read a specific file |
+| `heimdall://info` | Environment information |
+
+## Workspace
+
+Files are stored in the `workspace/` directory.
+
+### Configuration
+
+Customize the server behavior with environment variables:
+
+```json
+{
+  "mcpServers": {
+    "heimdall": {
+      "command": "node",
+      "args": ["dist/server.js"],
+      "cwd": "/path/to/heimdall",
+      "env": {
+        "HEIMDALL_WORKSPACE": "/custom/workspace/path",
+        "HEIMDALL_MAX_FILE_SIZE": "52428800",
+        "HEIMDALL_MAX_WORKSPACE_SIZE": "524288000",
+        "HEIMDALL_PYTHON_EXECUTION_TIMEOUT_MS": "5000"
+      }
+    }
+  }
+}
+```
+
+**Available environment variables:**
+
+| Variable | Description | Default | Format |
+|----------|-------------|---------|--------|
+| `HEIMDALL_WORKSPACE` | Path to workspace directory | `./workspace` | Absolute or relative path |
+| `HEIMDALL_MAX_FILE_SIZE` | Maximum size for a single file | `10485760` (10MB) | Bytes (positive integer) |
+| `HEIMDALL_MAX_WORKSPACE_SIZE` | Maximum total workspace size | `104857600` (100MB) | Bytes (positive integer) |
+| `HEIMDALL_PYTHON_EXECUTION_TIMEOUT_MS` | Python execution timeout | `5000` | Milliseconds (positive integer) |
+
+**Example:** To allow 50MB files and 500MB total workspace:
+- `HEIMDALL_MAX_FILE_SIZE`: `52428800` (50 * 1024 * 1024)
+- `HEIMDALL_MAX_WORKSPACE_SIZE`: `524288000` (500 * 1024 * 1024)
+
+## Security
+
+### Network Access
+
+**Python code cannot make network requests.** Pyodide runs in WebAssembly which provides a security boundary that prevents:
+- HTTP/HTTPS requests from Python code
+- Socket connections
+- Any external network communication initiated by user code
+
+This is enforced by the WASM runtime itself. Code that attempts to make network requests will fail with an error.
+
+### How Package Installation Works
+
+Package installation (`micropip.install()`) works because it uses **Pyodide's internal mechanism** which operates at the JavaScript/Node.js layer, not Python:
+
+```
+micropip.install("numpy")  →  Pyodide (JS)  →  Node.js fetch()  →  PyPI
+```
+
+This is intentional - packages can be installed via Pyodide's trusted mechanism, but user code cannot make arbitrary network requests.
+
+### What Works vs What's Blocked
+
+| ✅ Available | ❌ Blocked |
+|-------------|-----------|
+| Package installation (micropip) | `urllib.request.urlopen()` |
+| File I/O (workspace) | `requests.get()` |
+| Data processing (numpy, pandas) | Socket connections |
+| URL parsing (`urllib.parse`) | External API calls |
+| `loadPackagesFromImports()` | Data exfiltration |
+
+## Available Packages
+
+Pyodide includes many popular packages:
+
+### Pre-installed
+- Standard library (os, sys, json, re, math, etc.)
+- micropip (for installing more packages)
+
+### Available via `install_packages`
+- **Data Science**: numpy, pandas, scipy, scikit-learn
+- **Visualization**: matplotlib, seaborn, plotly
+- **HTML Parsing**: beautifulsoup4, lxml (parsing only, no fetching)
+- **Text/NLP**: regex, nltk
+- **Math**: sympy, statsmodels
+- **Image**: pillow
+
+### Limitations
+- **No network access** (WASM security boundary)
+- Packages with native C/Fortran code must have Pyodide-compatible wheels
+- No multiprocessing or threading
+- Memory constrained by Node.js heap
+
+See [Pyodide Packages](https://pyodide.org/en/stable/usage/packages-in-pyodide.html) for full compatibility list.
+
+## Project Structure
+
+```
+heimdall/
+├── src/
+│   ├── server.ts                # Entry point
+│   ├── config/
+│   │   └── constants.ts         # Configuration and limits
+│   ├── core/
+│   │   ├── bash-manager.ts      # Bash execution (just-bash)
+│   │   ├── pyodide-manager.ts   # Python execution coordinator
+│   │   ├── pyodide-worker.ts    # Worker thread for Python
+│   │   └── secure-fs.ts         # Secure filesystem wrapper
+│   ├── tools/
+│   │   ├── bash-execution.ts    # execute_bash tool
+│   │   ├── python-execution.ts  # execute_python tool
+│   │   └── filesystem.ts        # File operation tools
+│   ├── resources/               # MCP resource handlers
+│   ├── types/                   # TypeScript interfaces
+│   └── utils/                   # Utilities (async-lock, etc.)
+├── test/                        # Vitest tests
+├── dist/                        # Compiled output
+└── workspace/                   # Persistent file storage
+```
+
+## Development
+
+### Build
+
+```bash
+npm run build
+```
+
+### Test
+
+```bash
+npm test                 # Run all tests
+npm run test:watch       # Watch mode
+npm run test:coverage    # With coverage
+```
+
+### Validate (before committing)
+
+```bash
+npm run validate         # Type-check + lint + format + build
+```
+
+### Clean
+
+```bash
+npm run clean
+```
+
+## Bash and Python Interoperability
+
+Bash and Python share the same workspace filesystem, enabling powerful workflows:
+
+**Example: Bash prepares data, Python analyzes**
+
+```bash
+# Bash: Extract and clean data
+cat raw_data.csv | grep -v '^#' | sort > clean_data.csv
+```
+
+```python
+# Python: Analyze the cleaned data
+import pandas as pd
+df = pd.read_csv('/workspace/clean_data.csv')
+print(df.describe())
+```
+
+**Example: Python generates data, Bash processes**
+
+```python
+# Python: Generate report data
+import json
+data = [{"name": "Alice", "score": 95}, {"name": "Bob", "score": 87}]
+with open('/workspace/results.json', 'w') as f:
+    json.dump(data, f)
+```
+
+```bash
+# Bash: Extract specific fields
+cat results.json | jq '.[] | select(.score > 90) | .name'
+```
+
+## Security Considerations
+
+- ✅ Python runs in WebAssembly sandbox (memory-isolated)
+- ✅ Bash uses just-bash (no real process spawning)
+- ✅ No direct host filesystem access (only workspace)
+- ✅ Execution limits prevent infinite loops and runaway scripts
+- ✅ Limited networking capabilities
+- ⚠️ Workspace files are accessible to all code executions
+- ⚠️ Installed packages persist in the session
+
+## Troubleshooting
+
+### Slow first execution
+
+Pyodide downloads ~15MB on first run. Subsequent runs use cached files.
+
+### Package installation fails
+
+Some packages aren't available in Pyodide. Check compatibility at [pyodide.org](https://pyodide.org/en/stable/usage/packages-in-pyodide.html).
+
+### Memory errors
+
+WebAssembly has memory limits. For large datasets, process in chunks. You can increase Node.js heap with:
+
+```bash
+NODE_OPTIONS="--max-old-space-size=4096" npm start
+```
+
+## License
+
+MIT

package/dist/config/constants.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Host filesystem path to workspace directory
+ */
+export declare const WORKSPACE_DIR: string;
+/**
+ * Virtual filesystem path to workspace directory in Pyodide
+ */
+export declare const VIRTUAL_WORKSPACE = "/workspace";
+/**
+ * Maximum size for a single file (default: 10MB)
+ * Configure via HEIMDALL_MAX_FILE_SIZE environment variable (in bytes)
+ */
+export declare const MAX_FILE_SIZE: number;
+/**
+ * Maximum total workspace size (default: 100MB)
+ * Configure via HEIMDALL_MAX_WORKSPACE_SIZE environment variable (in bytes)
+ */
+export declare const MAX_WORKSPACE_SIZE: number;
+/**
+ * Maximum execution time for Python code (default: 5000ms)
+ * Configure via HEIMDALL_PYTHON_EXECUTION_TIMEOUT_MS environment variable
+ */
+export declare const PYTHON_EXECUTION_TIMEOUT_MS: number;
+//# sourceMappingURL=constants.d.ts.map

package/dist/config/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/config/constants.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,eAAO,MAAM,aAAa,QACuD,CAAC;AAElF;;GAEG;AACH,eAAO,MAAM,iBAAiB,eAAe,CAAC;AAkD9C;;;GAGG;AACH,eAAO,MAAM,aAAa,QAIzB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAI9B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,QAIvC,CAAC"}