preflight-mcp 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 preflight-mcp contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,42 +1,121 @@
 # preflight-mcp
 
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/)
+[![MCP Compatible](https://img.shields.io/badge/MCP-Compatible-blue)](https://modelcontextprotocol.io/)
+
 > **English** | [中文](./README.zh-CN.md)
 
-An MCP (Model Context Protocol) **stdio** server
+An MCP (Model Context Protocol) **stdio** server that creates evidence-based preflight bundles for GitHub repositories and library documentation.
 
 Each bundle contains:
 - A local copy of repo docs + code (normalized text)
 - A lightweight **full-text search index** (SQLite FTS5)
 - Agent-facing entry files: `START_HERE.md`, `AGENTS.md`, and `OVERVIEW.md` (factual-only, with evidence pointers)
 
-## What you get
-- **10 Tools** to create/update/search/verify/read bundles
+## Features
+
+- **12 MCP tools** to create/update/repair/search/verify/read bundles (plus resources)
+- **De-duplication**: prevent repeated indexing of the same normalized inputs
+- **Resilient GitHub fetching**: configurable git clone timeout + GitHub archive (zipball) fallback
+- **Offline repair**: rebuild missing/empty derived artifacts (index/guides/overview) without re-fetching
 - **Static facts extraction** via `analysis/FACTS.json` (non-LLM)
 - **Evidence-based verification** to reduce hallucinations
 - **Resources** to read bundle files via `preflight://...` URIs
 - **Multi-path mirror backup** for cloud storage redundancy
 - **Resilient storage** with automatic failover when mounts are unavailable
 
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Tools](#tools-12-total)
+- [Environment Variables](#environment-variables)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Requirements
+
 - Node.js >= 18
 - `git` available on PATH
 
-## Install
-Local dev:
-- `npm install`
-- `npm run build`
+## Installation
 
-Publish install (after you publish to npm):
-- `npm install -g preflight-mcp`
+### From npm (after published)
 
-## Use (stdio MCP server)
-This server communicates over stdin/stdout, so you typically run it via an MCP host (e.g. mcp-hub).
+```bash
+npm install -g preflight-mcp
+```
+
+### Local Development
 
-Example MCP host command:
-- `preflight-mcp`
+```bash
+git clone https://github.com/jonnyhoo/preflight-mcp.git
+cd preflight-mcp
+npm install
+npm run build
+```
 
-Or, for local dev:
-- `node dist/index.js`
+## Quick Start
+
+### 1. Configure MCP Host (e.g., Claude Desktop)
+
+Add to your MCP configuration file:
+
+```json
+{
+  "mcpServers": {
+    "preflight": {
+      "command": "npx",
+      "args": ["preflight-mcp"]
+    }
+  }
+}
+```
+
+Or for local development:
+
+```json
+{
+  "mcpServers": {
+    "preflight": {
+      "command": "node",
+      "args": ["path/to/preflight-mcp/dist/index.js"]
+    }
+  }
+}
+```
+
+### 2. Create Your First Bundle
+
+Ask your AI assistant:
+
+```
+"Create a bundle for the repository octocat/Hello-World"
+```
+
+This will:
+- Clone the repository
+- Index all docs and code
+- Generate searchable SQLite FTS5 index
+- Create `START_HERE.md`, `AGENTS.md`, and `OVERVIEW.md`
+
+### 3. Search the Bundle
+
+```
+"Search for 'GitHub' in the bundle"
+```
+
+### 4. Test Locally (Optional)
+
+Run end-to-end smoke test:
+
+```bash
+npm run smoke
+```
+
+This will test bundle creation, search, and update operations.
 
 ## Smoke test
 Runs an end-to-end stdio client that:
@@ -51,7 +130,7 @@ Command:
 
 Note: the smoke test clones `octocat/Hello-World` from GitHub, so it needs internet access.
 
-## Tools (10 total)
+## Tools (12 total)
 
 ### `preflight_list_bundles`
 List bundle IDs in storage.
@@ -61,10 +140,21 @@ List bundle IDs in storage.
 Create a new bundle from one or more inputs.
 - Triggers: "index this repo", "学习这个项目", "创建bundle"
 
+Key semantics:
+- **De-dup by default**: if a bundle already exists for the same normalized inputs, creation is rejected.
+- Use `ifExists` to control behavior:
+  - `error` (default): reject duplicate
+  - `returnExisting`: return the existing bundle without fetching
+  - `updateExisting`: update the existing bundle then return it
+  - `createNew`: bypass de-duplication
+- GitHub ingest uses **shallow clone**; if `git clone` fails, it will fall back to **GitHub archive (zipball)**.
+- Supports `repos.kind: "local"` to ingest from a local directory (e.g. an extracted zip).
+
 Input (example):
-- `repos`: `[{ kind: "github", repo: "owner/repo" }, { kind: "deepwiki", url: "https://deepwiki.com/owner/repo" }]`
+- `repos`: `[{ kind: "github", repo: "owner/repo" }, { kind: "local", repo: "owner/repo", path: "/path/to/dir" }, { kind: "deepwiki", url: "https://deepwiki.com/owner/repo" }]`
 - `libraries`: `["nextjs", "react"]` (Context7; optional)
 - `topics`: `["routing", "api"]` (Context7 topic filter; optional)
+- `ifExists`: `"error" | "returnExisting" | "updateExisting" | "createNew"`
 
 ### `preflight_read_file`
 Read a file from bundle (OVERVIEW.md, START_HERE.md, AGENTS.md, or any repo file).
@@ -90,30 +180,49 @@ Optional parameters:
 Batch update all bundles at once.
 - Triggers: "批量更新", "全部刷新"
 
+### `preflight_find_bundle`
+Check whether a bundle already exists for the given inputs (no fetching, no changes).
+- Use when your UI/agent wants to decide whether to create/update.
+
+### `preflight_repair_bundle`
+Offline repair for a bundle (no fetching): rebuild missing/empty derived artifacts.
+- Rebuilds `indexes/search.sqlite3`, `START_HERE.md`, `AGENTS.md`, `OVERVIEW.md` when missing/empty.
+- Use when: search fails due to index corruption, bundle files were partially deleted, etc.
+
 ### `preflight_search_bundle`
 Full-text search across ingested docs/code (line-based SQLite FTS5).
 - Triggers: "搜索bundle", "在仓库中查找", "搜代码"
 
-Optional parameters:
-- `ensureFresh`: If true, check if bundle needs update before searching.
-- `maxAgeHours`: Max age in hours before triggering auto-update (default: 24).
+Important: **this tool is strictly read-only**.
+- `ensureFresh` / `maxAgeHours` are **deprecated** and will error if provided.
+- To update: call `preflight_update_bundle`, then search again.
+- To repair: call `preflight_repair_bundle`, then search again.
 
 ### `preflight_search_by_tags`
 Search across multiple bundles filtered by tags (line-based SQLite FTS5).
 - Triggers: "search in MCP bundles", "search in all bundles", "在MCP项目中搜索", "搜索所有agent"
 
+Notes:
+- This tool is read-only and **does not auto-repair**.
+- If some bundles fail to search (e.g. missing/corrupt index), they will be reported in `warnings`.
+
 Optional parameters:
 - `tags`: Filter bundles by tags (e.g., `["mcp", "agents"]`)
 - `scope`: Search scope (`docs`, `code`, or `all`)
 - `limit`: Max total hits across all bundles
 
+Output additions:
+- `warnings?: [{ bundleId, kind, message }]` (non-fatal per-bundle errors)
+- `warningsTruncated?: true` if warnings were capped
+
 ### `preflight_verify_claim`
 Find evidence for a claim/statement in bundle.
 - Triggers: "验证说法", "找证据", "这个对吗"
 
-Optional parameters:
-- `ensureFresh`: If true, check if bundle needs update before verifying.
-- `maxAgeHours`: Max age in hours before triggering auto-update (default: 24).
+Important: **this tool is strictly read-only**.
+- `ensureFresh` / `maxAgeHours` are **deprecated** and will error if provided.
+- To update: call `preflight_update_bundle`, then verify again.
+- To repair: call `preflight_repair_bundle`, then verify again.
 
 ## Resources
 ### `preflight://bundles`
@@ -126,6 +235,24 @@ Examples:
 - `preflight://bundle/<id>/file/START_HERE.md`
 - `preflight://bundle/<id>/file/repos%2Fowner%2Frepo%2Fnorm%2FREADME.md`
 
+## Error semantics (stable, UI-friendly)
+Most tool errors are wrapped with a stable, machine-parseable prefix:
+- `[preflight_error kind=<kind>] <message>`
+
+Common kinds:
+- `bundle_not_found`
+- `file_not_found`
+- `invalid_path` (unsafe path traversal attempt)
+- `permission_denied`
+- `index_missing_or_corrupt`
+- `deprecated_parameter`
+- `unknown`
+
+This is designed so UIs/agents can reliably decide whether to:
+- call `preflight_update_bundle`
+- call `preflight_repair_bundle`
+- prompt the user for a different bundleId/path
+
 ## Environment variables
 ### Storage
 - `PREFLIGHT_STORAGE_DIR`: bundle storage dir (default: `~/.preflight-mcp/bundles`)
@@ -138,20 +265,21 @@ Examples:
 - `PREFLIGHT_ANALYSIS_MODE`: Static analysis mode - `none` or `quick` (default: `quick`). Generates `analysis/FACTS.json`.
 
 ### GitHub & Context7
-- `GITHUB_TOKEN`: optional; used for GitHub API/auth patterns (currently not required for public repos)
+- `GITHUB_TOKEN`: optional; used for GitHub API/auth patterns and GitHub archive fallback (public repos usually work without it)
+- `PREFLIGHT_GIT_CLONE_TIMEOUT_MS`: optional; max time to allow `git clone` before failing over to archive (default: 5 minutes)
 - `CONTEXT7_API_KEY`: optional; enables higher Context7 limits (runs without a key but may be rate-limited)
 - `CONTEXT7_MCP_URL`: optional; defaults to Context7 MCP endpoint
 
 ## Bundle layout (on disk)
 Inside a bundle directory:
-- `manifest.json`
+- `manifest.json` (includes `fingerprint`, `displayName`, `tags`, and per-repo `source`)
 - `START_HERE.md`
 - `AGENTS.md`
 - `OVERVIEW.md`
 - `indexes/search.sqlite3`
 - **`analysis/FACTS.json`** (static analysis)
 - `repos/<owner>/<repo>/raw/...`
-- `repos/<owner>/<repo>/norm/...`
+- `repos/<owner>/<repo>/norm/...` (GitHub/local snapshots)
 - `deepwiki/<owner>/<repo>/norm/index.md` (DeepWiki sources)
 - `deepwiki/<owner>/<repo>/meta.json`
 - `libraries/context7/<...>/meta.json`
@@ -179,7 +307,7 @@ $env:PREFLIGHT_STORAGE_DIRS = "D:\OneDrive\preflight;E:\GoogleDrive\preflight"
 ```
 ```bash
 # macOS/Linux
-export PREFLIGHT_STORAGE_DIRS="$HOME/OneDrive/preflight:$HOME/Dropbox/preflight"
+export PREFLIGHT_STORAGE_DIRS="$HOME/OneDrive/preflight;$HOME/Dropbox/preflight"
 ```
 
 ### MCP host config (Claude Desktop)
@@ -206,3 +334,43 @@ export PREFLIGHT_STORAGE_DIRS="$HOME/OneDrive/preflight:$HOME/Dropbox/preflight"
 ### Important notes
 - **Avoid concurrent access**: Only use on one machine at a time (SQLite conflicts)
 - **Wait for sync**: After updates, wait for cloud sync before switching machines
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details on:
+
+- Development setup
+- Code style guidelines
+- Testing requirements
+- Pull request process
+
+Please also read our [Code of Conduct](./CODE_OF_CONDUCT.md) before contributing.
+
+## Support
+
+If you encounter any issues or have questions:
+
+- **Issues**: [GitHub Issues](https://github.com/jonnyhoo/preflight-mcp/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/jonnyhoo/preflight-mcp/discussions)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+The MIT License allows you to:
+- Use commercially
+- Modify
+- Distribute
+- Use privately
+
+With the only requirement being to include the original copyright and license notice.
+
+## Acknowledgments
+
+- Built on the [Model Context Protocol](https://modelcontextprotocol.io/)
+- Uses SQLite FTS5 for efficient full-text search
+- Inspired by the need for evidence-based AI assistance
+
+---
+
+Made with ❤️ for the AI developer community