MARGINNOOK / DEVELOPER PREVIEW

Quickstart: available samples and local clients

Understand the preview and run the verified clients against an authorized local instance.

Developer preview. Hosted API is not live yet. Explore fixed synthetic samples; anonymous uploads, hosted execution and payments remain closed.

What you can use today

The public site offers fixed samples generated by the real local processing core, HTML documentation and five client files. The backend source repository is private. There is no publicly downloadable server package, pip/npm SDK or anonymous hosted endpoint.

Server setup below is for operators who already have authorized repository access. Downloading a client alone does not provide a running service.

Authorized local setup

The hashed runtime lock targets CPython 3.12 / Linux x86_64. macOS requires an architecture-specific resolved environment; do not claim the Linux lock is verified there. Use the existing tested local environment or follow repository operator instructions.

git clone https://github.com/gaozichen2012/marginnook.git
cd marginnook
python3.12 -m venv .venv
. .venv/bin/activate
python -m pip install --require-hashes -r requirements.lock
PYTHONPATH=backend OTEL_SDK_DISABLED=true python -m marginnook_core.api

Run a client in a second terminal

python examples/http_client.py http://127.0.0.1:8000
node examples/http_client.mjs http://127.0.0.1:8000
PYTHONPATH=examples OTEL_SDK_DISABLED=true python examples/mcp_client.py http://127.0.0.1:8000
node examples/mcp_client.mjs http://127.0.0.1:8000

Client commands were previously executed with Python 3.12 and Node 24 on macOS. A successful aggregation includes books count 2 and sum "19.75". The demo removes its synthetic resource family on completion. Server installation above is an operator procedure, not a new cross-platform installation test.

Download Python HTTP and Python MCP together; MCP needs the project’s official SDK dependencies. Download exact_json.mjs beside Node HTTP or Node MCP. HTTP clients need no extra client packages.

Recovery

Keep the original endpoint and private working directory; append --resume to the same command. Recovery uses the saved job or original key. Unknown upload outcomes stop. Credentials and .runtime recovery files are private.