diff --git a/PRODUCT.md b/PRODUCT.md deleted file mode 100644 index 2a97251..0000000 --- a/PRODUCT.md +++ /dev/null @@ -1,52 +0,0 @@ -# mpak - -mpak is the open-source MCPB (MCP Bundle) registry: a package manager and distribution platform for MCP servers. It lets developers package MCP servers as self-contained bundles, publish them to the registry, and install them with a single CLI command. - -## Status - -OSS. Core registry (API, web, CLI, scanner) is public. Trust framework is a separate public repo. No private components. - -## Domains - -| Domain | Purpose | -|--------|---------| -| `mpak.dev` | Bundle registry web UI (search, browse, install) | -| `registry.mpak.dev` | MCP server discovery API | - -## Repos / Paths in hq - -| Path | Description | -|------|-------------| -| `products/mpak/code/` | This repo: monorepo (API, web, CLI, scanner, SDK) | -| `products/mpak/trust/` | mpak Trust Framework (MTF) security standard | -| `products/mpak/awesome/` | awesome-mcpb: curated list of MCPB bundles | -| `deployments/mpak/` | Kubernetes deployment config | - -## Monorepo Layout - -``` -apps/ - api/ # REST API (Hono, Node) - web/ # Registry web UI (Next.js) - cli/ # mpak CLI (Node) - scanner/ # Bundle scanner/validator -packages/ - sdk-typescript/ # JS/TS SDK - sdk-python/ # Python SDK (OpenAPI-generated types) -``` - -## Deployment - -See `deployments/mpak/CLAUDE.md` for environment config, deploy commands, and secrets management. - -Environments: `staging` (default), `production`. - -## Trust Framework - -The mpak Trust Framework (MTF) defines security and provenance standards for published bundles. It lives at `products/mpak/trust/` and is published at `mpaktrust.org`. - -## Key Concepts - -- **MCPB bundle**: A zip containing an MCP server + `manifest.json` + deps. Self-contained, no install step. -- **mpak install**: Downloads a bundle, verifies integrity, configures the MCP client. -- **Registry**: Hosts bundle metadata, download counts, trust scores. diff --git a/apps/scanner/CLAUDE.md b/apps/scanner/CLAUDE.md index e4cfd4c..8531224 100644 --- a/apps/scanner/CLAUDE.md +++ b/apps/scanner/CLAUDE.md @@ -181,17 +181,6 @@ Releases are automated via GitHub Actions and PyPI trusted publishing. Pushing a CI handles PyPI publish and Docker build/push to `ghcr.io/nimblebraininc/mpak-scanner`. See `.github/workflows/scanner-publish.yml`. -### Production Deployment (ECR/K8s) - -After the PyPI release, deploy the scanner to production K8s (from `hq/deployments/mpak/`): - -```bash -make deploy-scanner ENV=production -make apply-scanner-infra ENV=production # only if RBAC/secrets changed -``` - -The Makefile builds from the Dockerfile which pulls the version from PyPI. - ### Schemas and Rules - **Schemas** (JSON Schema for manifest validation): Fetched at runtime from `mpaktrust.org`. Minimal fallbacks are hardcoded in `schemas.py`. Not bundled in the wheel. diff --git a/apps/scanner/README.md b/apps/scanner/README.md index 31e3563..bc3fa69 100644 --- a/apps/scanner/README.md +++ b/apps/scanner/README.md @@ -174,8 +174,6 @@ docker pull ghcr.io/nimblebraininc/mpak-scanner:latest docker run --rm -v /path/to/bundle.mcpb:/bundle.mcpb ghcr.io/nimblebraininc/mpak-scanner scan /bundle.mcpb ``` -For production deployment to ECR/K8s, see `deployments/mpak/`. - ## Related Projects - [mpak registry](https://mpak.dev) - Search, download, and publish MCP bundles