# my-pi

**Category:** 💻 Developer Tools  
**Repository:** https://github.com/BoxBoxmari/my-pi  
**Views:** 0  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/my-pi

## Description
Local-first MCP runtime for coding agents with safe workspace access, AST/LSP navigation, and Git.

## Claude Desktop Quick Installation
Heuristic fallback — verify the package name and runner against the repository README before running it. Uses `npx` (confidence: low):

```json
"mcpServers": {
  "my-pi": {
    "command": "npx",
    "args": ["-y","my-pi"]
  }
}
```

## Documentation & README

# my-pi

<p align="center">
  <strong>Local-first MCP runtime for coding agents — safer workspace access without an unrestricted shell</strong><br>
  <sub>Bounded filesystem · content-preconditioned writes · Tree-Sitter AST search · LSP navigation · Git tooling</sub>
</p>

<p align="center">
  <a href="https://github.com/BoxBoxmari/my-pi/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/BoxBoxmari/my-pi/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI status" /></a>
  <a href="https://github.com/BoxBoxmari/my-pi/actions/workflows/codeql.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/BoxBoxmari/my-pi/codeql.yml?branch=main&label=CodeQL&logo=github&style=flat-square" alt="CodeQL status" /></a>
  <a href="https://www.npmjs.com/package/@koonwang03/my-pi"><img src="https://img.shields.io/npm/v/%40koonwang03%2Fmy-pi?label=npm&logo=npm&style=flat-square" alt="npm version" /></a>
  <a href="https://mcpservers.org/servers/boxboxmari/my-pi"><img src="https://mcpservers.org/badge.svg" alt="Listed on mcpservers.org" /></a>
  <a href="https://glama.ai/mcp/servers/BoxBoxmari/my-pi"><img src="https://glama.ai/mcp/servers/BoxBoxmari/my-pi/badges/score.svg" alt="my-pi MCP server – quality and maintenance score on Glama" /></a>
  <a href="https://github.com/BoxBoxmari/my-pi/stargazers"><img src="https://img.shields.io/github/stars/BoxBoxmari/my-pi?logo=github&style=flat-square" alt="GitHub stars" /></a>
  <a href="https://github.com/BoxBoxmari/my-pi/blob/HEAD/LICENSE"><img src="https://img.shields.io/github/license/BoxBoxmari/my-pi?style=flat-square" alt="MIT license" /></a>
  <img src="https://img.shields.io/badge/status-alpha-orange?style=flat-square" alt="Alpha status" />
</p>

<p align="center">
  <a href="https://glama.ai/mcp/servers/BoxBoxmari/my-pi">
    <img src="https://glama.ai/mcp/servers/BoxBoxmari/my-pi/badges/card.svg" alt="my-pi MCP server – quality and maintenance score on Glama" />
  </a>
</p>

## What is my-pi?

**my-pi** is a deterministic local coding capability runtime exposed through the official **Model Context Protocol (MCP)**. It gives MCP-capable coding agents controlled access to a real workspace through explicit workspace authority, bounded reads, guarded writes, structural search, language-server intelligence, and Git operations.

It is aimed at developers who want agentic coding tools to understand and modify code **without handing the agent a general-purpose shell or silently granting the current working directory**.

### Why use it?

- **Local-first:** source code and detailed workspace state remain on the host.
- **Read-only by default:** writes and language-server process startup require explicit `trusted` elevation.
- **Safer mutation:** writes can require SHA-256 content preconditions instead of blind overwrite semantics.
- **Code-aware search:** Tree-Sitter structural search across TypeScript, JavaScript, Python, Rust, and Go.
- **Semantic navigation:** LSP symbols, definitions, references, hover, and diagnostics for supported host language servers.
- **Git-aware context:** bounded status and diff operations with secret filtering and large-diff spillover.
- **No secondary paid LLM dependency:** the core runtime executes locally and does not select models or spawn agents.

> **Release channel:** Alpha. The npm badge above is authoritative for the currently published package version. This repository may contain a newer release candidate before publication completes. Suitable for evaluation and controlled local development; review the [security model](https://github.com/BoxBoxmari/my-pi/blob/HEAD/docs/SECURITY_MODEL.md) before enabling the trusted profile.

## Install in under a minute

Requires Node.js `>=24.0.0` (Node 24 LTS is the normative runtime).

```bash
npm install -g @koonwang03/my-pi
my-pi-mcp --workspace /path/to/your/project
```

The server starts read-only. For a workspace you explicitly trust:

```bash
my-pi-mcp --workspace /path/to/your/project --security-profile trusted
```

Or inspect a host configuration without a global install:

```bash
npx --yes --package @koonwang03/my-pi my-pi-mcp host-config cursor-local
```

Generate host-specific configuration snippets:

```bash
my-pi-mcp host-config claude-code-local
my-pi-mcp host-config cursor-local
my-pi-mcp host-config opencode-current-local
```

Starting without `--workspace` or `MY_PI_WORKSPACE_ROOT` fails closed. Use `--allow-cwd` only when granting the current directory is intentional.

The published npm package is the stable MCP server. The coordination daemon and
local UI are private workspace packages used by the experimental source build;
build the repository before using those components.

## 13-tool MCP surface

| Area | Tools | Purpose |
| :--- | :--- | :--- |
| Filesystem | `fs_read`, `fs_write`, `fs_patch`, `fs_stat` | Bounded reads, guarded writes/patches, metadata |
| Search & workspace | `search`, `workspace_info` | Repository exploration and authoritative workspace state |
| AST & LSP | `ast_search`, `lsp_status`, `lsp_symbols`, `lsp_navigate`, `lsp_diagnostics` | Structural and semantic code intelligence |
| Git | `vcs_status`, `vcs_diff` | Repository status and bounded/filtered diffs |

### Key guarantees

| Capability | Behavior |
| :--- | :--- |
| Content-preconditioned mutation | File updates verify raw SHA-256 fingerprints and reject stale guarded overwrites |
| Pre-read sensitive-path policy | Sensitive paths such as `.env*`, `.aws/`, `.ssh/`, and `*.key` are denied before content is allocated to model context |
| Explicit security profiles | Default is read-only; mutation and LSP process startup require explicit elevation |
| Encoding/mode fidelity | File replacement preserves relevant encoding, line endings, BOM, and POSIX executable mode behavior |
| Cancellation | Long-running Git/search/LSP subprocess work supports cancellation and cleanup |

## Architecture

```text
MCP-capable coding host
        │
        │ stdio
        ▼
┌─────────────────────┐
│   my-pi MCP edge    │
└──────────┬──────────┘
           ▼
┌─────────────────────┐
│ capability contracts│
└──────────┬──────────┘
           ▼
┌─────────────────────────────────────────────────────────┐
│ workspace │ policy │ filesystem │ search │ AST │ LSP │ Git │
└─────────────────────────────────────────────────────────┘
           │
           └── local host workspace
```

The stable public claim is the 13-tool MCP capability surface. The repository also contains two opt-in candidates that never change the default mode:

- **Production Next** — coordination, code-state, change-receipt, evaluation, and feedback features, subject to their promotion gates.
- **Visual Plane** — a read-only graph/theater projection of authoritative local state, plus a mutation-provenance and local-admission path.

## Build from source

```bash
git clone https://github.com/BoxBoxmari/my-pi.git
cd my-pi
pnpm install --frozen-lockfile
pnpm build
```

Prerequisites for repository development:

- Node.js `v24.0.0+` (Node 24 LTS normative; exact-minimum `24.0.0` lane is qualified in CI)
- pnpm `v11.2.2+`
- Rust stable is optional and currently relevant only to the deferred native-backend scaffold

## Verification

```bash
# Local code, architecture, boundary, build, tests, gates and smoke verification
pnpm verify

# Unit/integration suite
pnpm test

# SBOM validation
pnpm verify:sbom

# Release admission checks
pnpm bind:evidence
pnpm verify:release
```

The configured CI matrix covers Ubuntu, Windows, and macOS lanes. See the live workflow badges above for current status rather than relying on static claims in this document.

### Engineering contracts

| Contract | Document | Enforced by |
| :--- | :--- | :--- |
| Runtime compatibility (engines/types/CI parity) | [`docs/RUNTIME_CONTRACT.md`](https://github.com/BoxBoxmari/my-pi/blob/HEAD/docs/RUNTIME_CONTRACT.md) | `node scripts/check-runtime-contract.mjs` |
| Test/invariant coverage | [`docs/TEST_CONTRACT.md`](https://github.com/BoxBoxmari/my-pi/blob/HEAD/docs/TEST_CONTRACT.md) | `pnpm check:contract` (`scripts/verify-test-contract.mjs`) |
| Merge/release governance | [`docs/GITHUB_GOVERNANCE.md`](https://github.com/BoxBoxmari/my-pi/blob/HEAD/docs/GITHUB_GOVERNANCE.md) | `ci-required` + CodeQL required checks |
| Worktree identity isolation | [`packages/code-state/IDENTITY.md`](https://github.com/BoxBoxmari/my-pi/blob/HEAD/packages/code-state/IDENTITY.md) | ownership guard + invariant suites |

## Benchmarks

The repository contains deterministic synthetic benchmarks for MCP stdio overhead, search/traversal throughput, memory sampling, runtime boundaries, coordination behavior, impact routing, evaluation feedback, and local reliability. Benchmark outputs are candidate evidence; performance claims should be interpreted alongside their qualification criteria and runner variance.

### Self-hosted tracks and promotion

The self-hosted program keeps implementation, measurement, and promotion as
separate decisions:

- **Track A — evidence harness:** ObservedTask v2 tasks are committed and
  receipt-bound before a run. Control and treatment arms use isolated worktrees,
  independent downstream adjudication, and fail-closed aggregation.
- **Track B — enforcement:** mutation provenance, local admission, portable
  attestation, and host policy bundles distinguish managed changes from
  unmanaged or review-required changes. Report-mode results do not imply strict
  host enforcement.
- **Track C — visual plane:** the graph and theater views project authoritative
  local state through the daemon, loopback portal, or opt-in MCP Apps resources.
  These views do not change the default 13-tool catalog.

The current evidence files under `evidence/` are candidate-bound records, not a
release or promotion claim. A passing test, a qualified sample, or an accepted
individual evidence record does not by itself open PN11. Use the read-only
promotion verifier as the authority:

```bash
pnpm verify:observed-v2
pnpm verify:production-next-evidence
pnpm verify:production-next-promotion
```

Keep PN11 withheld unless the final command reports
`promotionEligible: true`. Do not reclassify legacy or missing-result records by
editing their metadata after a run.

## Production Next (experimental)

Start the local coordination candidate for a logical project:

```bash
my-pi-daemon --workspace /path/to/your/project
my-pi-mcp --workspace /path/to/your/project --coordination
```

Add `--evaluation` only when the evaluation plane is required. The candidate keeps source and detailed code state local, does not select models or spawn agents, and does not require a hosted control plane.

Relevant qualification commands include:

```bash
pnpm bench:impact-arms
pnpm bench:evaluation-feedback-arms
pnpm dogfood:self-host
pnpm bench:local-reliability
pnpm verify:production-next
pnpm verify:production-next-promotion
```

`pnpm verify:production-next-promotion` is the read-only promotion verifier; it is the authoritative gate and is never weakened to match available results.

## Visual Plane (experimental)

An opt-in, read-only visualization surface renders authoritative local state as a bounded graph. It is a **projection** of the coordination graph snapshot and event log — not an LLM-generated diagram — and it never mutates source state.

```bash
# 1) Start the local coordination daemon for a project
my-pi-daemon --workspace /path/to/your/project

# 2) Serve the read-only Agent Operations Theater on loopback (prints its URL)
node apps/my-pi-ui/dist/main.js /path/to/your/project
# then open the printed URL with ?view=theater3d
```

- **Agent Operations Theater** renders a Three.js isometric work graph (agents, work items, intents, dependencies) with live event cues, a replay timeline, an evidence/trace/provenance inspector, and an automatic 2D SVG fallback when WebGL is unavailable.
- **Honest data states:** `degraded`, `truncated`, `stale`, and `empty` are always surfaced; unknown event types never drive motion; sensitive paths embedded in free-text values are redacted on every wire exit.
- **Hosts:** the same browser artifact is exposed through MCP Apps as the opt-in `ui://my-pi/theater` resource behind `--visuals`. The default MCP catalog remains exactly 13 tools.
- **Boundary:** the portal binds to loopback only and requires a per-launch session token; it is read-only in V1.

## Mutation provenance and local admission (experimental)

- **Observe mode** classifies observed code-state transitions as `managed`, `unmanaged`, `stale_lineage`, `unknown`, or `exempt` against verified my-pi change receipts — an external edit never becomes `managed` by observing final bytes.
- **Local admission** compares a Git change set with verified lineage and returns path-level `allowed` / `rejected` / `review_required` findings.
- **Portable attestation:** a canonical, cross-platform admission subject digest can be signed with Ed25519 (private key stored outside the workspace) and verified in CI without local SQLite state. The GitHub check runs in **report mode** until its qualification gates pass.
- **Host policy bundles** declare each host's enforcement maturity (`strict-capable` / `managed` / `monitoring`); a profile is never labeled strict-certified without seeded bypass evidence.

```bash
pnpm measure:track-b-report-mode
pnpm measure:track-b-strict-candidate
pnpm measure:track-b-host-bypass
```

## Package topology

```text
apps/
├── my-pi-mcp/             # MCP stdio server entry (stable 13-tool surface)
├── my-pi-daemon/          # Local per-project coordination/evaluation authority
└── my-pi-ui/              # Read-only local portal + shared browser graph artifact

packages/
├── contracts/             # Core interfaces, error codes, fingerprinting
├── workspace-runtime/     # Workspace/path normalization and mutation coordination
├── policy/                # Sensitive-path protection
├── artifact-store/        # Disk-backed spillover artifacts
├── observability/         # Tracing, metrics, and wire redaction contracts
├── fs/                    # Hardened filesystem capabilities
├── search/                # Grep/glob traversal
├── hashline/              # Hashline-anchored patch engine
├── ast/                   # Tree-Sitter structural search
├── lsp/                   # Multi-language LSP lifecycle/client
├── vcs/                   # Git-backed status and diff
├── mcp-adapter/           # MCP stdio server adapter (incl. opt-in MCP Apps resources)
├── host-profiles/         # Host configuration renderers and policy bundles
├── change-runtime/        # Content preconditions, change receipts, admission subject/attestation
├── code-state/            # Filesystem/AST/LSP/VCS code state and mutation provenance
├── coordination-client/   # Local daemon client
├── coordination-runtime/  # Work graph, claims, intents, sync
├── coordination-store/    # SQLite event/projection store
├── context-router/        # Bounded context routing
├── impact-engine/         # Bounded impact/routing decisions
├── evaluation-runtime/    # Evaluation and feedback flow
├── graph-model/           # Protocol/UI-neutral graph contracts (incl. theater frame)
├── graph-projection/      # Deterministic code/impact/work/lineage projectors
├── native-loader/         # Deferred native-backend loader
├── native-ports/          # Deferred native-backend ports
└── testing/               # Shared test utilities
```

Search-ignore behavior is documented in [`docs/SEARCH_IGNORE.md`](https://github.com/BoxBoxmari/my-pi/blob/HEAD/docs/SEARCH_IGNORE.md). It is a traversal optimization, not a substitute for sensitive-path policy.

## Security

Before using trusted mode, read [`docs/SECURITY_MODEL.md`](https://github.com/BoxBoxmari/my-pi/blob/HEAD/docs/SECURITY_MODEL.md). Security findings are welcome through the repository's documented reporting process.

## Contributing

Issues, reproducible bug reports, benchmark counterexamples, integration feedback, and focused pull requests are welcome. If you are evaluating my-pi in a real coding host, include the host, OS, Node version, security profile, and a minimal reproduction where possible.

## License

MIT — see [LICENSE](https://github.com/BoxBoxmari/my-pi/blob/HEAD/LICENSE).

