Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,8 @@ Manual contract definitions that supplement auto-extraction:

Environment variables are **fallbacks** — `.preflight/` config takes precedence when present.

> **💡 Ready-to-use example configs:** Copy [`examples/.preflight/`](examples/.preflight/) into your project root to get started quickly. See [`examples/.preflight/README.md`](examples/.preflight/README.md) for details.

---

## Embedding Providers
Expand Down
24 changes: 24 additions & 0 deletions examples/.preflight/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Example `.preflight/` Config

Copy this directory into your project root to get started:

```bash
cp -r examples/.preflight /path/to/your/project/
```

Then edit the files to match your project:

| File | Purpose |
|------|---------|
| `config.yml` | Profile, related projects, thresholds, embedding provider |
| `triage.yml` | Keyword rules and strictness for prompt classification |
| `contracts/*.yml` | Manual type/interface definitions for cross-service awareness |

All files are optional — preflight works without any config. These let you tune it for your team and codebase.

## Tips

- **Commit `.preflight/` to your repo** so the whole team shares the same rules
- **Start with `strictness: standard`**, then relax or tighten based on your experience
- **Add domain terms to `always_check`** that are frequently ambiguous in your codebase (e.g., "billing", "permissions")
- **Use contracts** for types that live in a separate repo or aren't auto-detected
31 changes: 31 additions & 0 deletions examples/.preflight/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# .preflight/config.yml
# Drop this in your project root. Every field is optional.
# See: https://github.com/TerminalGravity/preflight#configuration-reference

# Profile controls how much detail preflight returns.
# "minimal" — only flags ambiguous+, skips clarification detail
# "standard" — default behavior
# "full" — maximum detail on every non-trivial prompt
profile: standard

# Related projects for cross-service contract awareness.
# When your prompt mentions a keyword from a related project,
# triage escalates to cross-service and searches those projects.
related_projects:
- path: /Users/you/projects/auth-service
alias: auth
- path: /Users/you/projects/shared-types
alias: shared

# Behavioral thresholds
thresholds:
session_stale_minutes: 30 # warn if no activity for this long
max_tool_calls_before_checkpoint: 100 # suggest checkpoint after N tool calls
correction_pattern_threshold: 3 # min corrections before forming a pattern

# Embedding provider for timeline search
# "local" uses Xenova (zero config, runs on-device)
# "openai" uses text-embedding-3-small (faster, needs API key)
embeddings:
provider: local
# openai_api_key: sk-... # only needed if provider is "openai"
35 changes: 35 additions & 0 deletions examples/.preflight/contracts/api.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# .preflight/contracts/api.yml
# Manual contract definitions that supplement auto-extraction.
# Use these when preflight can't auto-detect your shared types,
# or when you want to be explicit about cross-service boundaries.

- name: User
kind: interface
description: Core user object shared across services
fields:
- name: id
type: string
required: true
- name: email
type: string
required: true
- name: role
type: "'admin' | 'member' | 'viewer'"
required: true
- name: teamId
type: string
required: false

- name: ApiResponse
kind: interface
description: Standard API response wrapper
fields:
- name: data
type: T
required: true
- name: error
type: string
required: false
- name: meta
type: "{ page: number, total: number }"
required: false
36 changes: 36 additions & 0 deletions examples/.preflight/triage.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# .preflight/triage.yml
# Controls the triage classification engine.
# Customize which prompts get flagged, skipped, or escalated.

rules:
# Prompts containing these words → always at least AMBIGUOUS.
# Add domain terms that are frequently underspecified in your codebase.
always_check:
- rewards
- permissions
- migration
- schema
- billing

# Prompts containing these words → TRIVIAL (pass through without checks).
# Safe, low-risk operations that don't need guardrails.
skip:
- commit
- format
- lint
- prettier

# Prompts containing these words → CROSS-SERVICE.
# Triggers a search across related_projects defined in config.yml.
cross_service_keywords:
- auth
- notification
- event
- webhook
- queue

# How aggressively to classify prompts.
# "relaxed" — more prompts pass as clear (experienced users)
# "standard" — balanced (recommended)
# "strict" — more prompts flagged as ambiguous (teams, onboarding)
strictness: standard
3 changes: 2 additions & 1 deletion src/tools/sequence-tasks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ export function registerSequenceTasks(server: McpServer): void {
// For locality: infer directories from path-like tokens in task text
if (strategy === "locality") {
// Use git ls-files with a depth limit instead of find for performance
const gitFiles = run("git ls-files 2>/dev/null | head -1000");
const gitFilesRaw = run(["ls-files"]);
const gitFiles = gitFilesRaw.split("\n").slice(0, 1000).join("\n");
const knownDirs = new Set<string>();
for (const f of gitFiles.split("\n").filter(Boolean)) {
const parts = f.split("/");
Expand Down
16 changes: 12 additions & 4 deletions src/tools/session-handoff.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@ import { z } from "zod";
import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { existsSync, readFileSync } from "fs";
import { join } from "path";
import { execFileSync } from "child_process";
import { run, getBranch, getRecentCommits, getStatus } from "../lib/git.js";
import { readIfExists, findWorkspaceDocs } from "../lib/files.js";
import { STATE_DIR, now } from "../lib/state.js";

/** Check if a CLI tool is available */
/** Check if a CLI tool is available on PATH */
function hasCommand(cmd: string): boolean {
const result = run(`command -v ${cmd} 2>/dev/null`);
return !!result && !result.startsWith("[command failed");
try {
execFileSync("which", [cmd], { encoding: "utf-8", stdio: ["pipe", "pipe", "pipe"] });
return true;
} catch { return false; }
}

export function registerSessionHandoff(server: McpServer): void {
Expand Down Expand Up @@ -44,7 +47,12 @@ export function registerSessionHandoff(server: McpServer): void {

// Only try gh if it exists
if (hasCommand("gh")) {
const openPRs = run("gh pr list --state open --json number,title,headRefName 2>/dev/null || echo '[]'");
let openPRs = "[]";
try {
openPRs = execFileSync("gh", ["pr", "list", "--state", "open", "--json", "number,title,headRefName"], {
encoding: "utf-8", timeout: 10000, stdio: ["pipe", "pipe", "pipe"],
}).trim();
} catch { /* gh not authed or no remote — skip */ }
if (openPRs && openPRs !== "[]") {
sections.push(`## Open PRs\n\`\`\`json\n${openPRs}\n\`\`\``);
}
Expand Down
10 changes: 5 additions & 5 deletions src/tools/sharpen-followup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ function parsePortelainFiles(output: string): string[] {
/** Get recently changed files, safe for first commit / shallow clones */
function getRecentChangedFiles(): string[] {
// Try HEAD~1..HEAD, fall back to just staged, then unstaged
const commands = [
"git diff --name-only HEAD~1 HEAD 2>/dev/null",
"git diff --name-only --cached 2>/dev/null",
"git diff --name-only 2>/dev/null",
const commands: string[][] = [
["diff", "--name-only", "HEAD~1", "HEAD"],
["diff", "--name-only", "--cached"],
["diff", "--name-only"],
];
const results = new Set<string>();
for (const cmd of commands) {
Expand Down Expand Up @@ -87,7 +87,7 @@ export function registerSharpenFollowup(server: McpServer): void {
// Gather context to resolve ambiguity
const contextFiles: string[] = [...(previous_files ?? [])];
const recentChanged = getRecentChangedFiles();
const porcelainOutput = run("git status --porcelain 2>/dev/null");
const porcelainOutput = run(["status", "--porcelain"]);
const untrackedOrModified = parsePortelainFiles(porcelainOutput);

const allKnownFiles = [...new Set([...contextFiles, ...recentChanged, ...untrackedOrModified])].filter(Boolean);
Expand Down
46 changes: 34 additions & 12 deletions src/tools/token-audit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,37 @@ import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { run } from "../lib/git.js";
import { readIfExists, findWorkspaceDocs, PROJECT_DIR } from "../lib/files.js";
import { loadState, saveState, now, STATE_DIR } from "../lib/state.js";
import { readFileSync, existsSync, statSync } from "fs";
import { readFileSync, existsSync, statSync, openSync, readSync, closeSync } from "fs";
import { join } from "path";

/** Shell-escape a filename for safe interpolation */
function shellEscape(s: string): string {
return s.replace(/'/g, "'\\''");
/** Count lines in a file using Node.js fs (no shell needed). Returns 0 on error. */
function countLines(filePath: string): number {
try {
const abs = join(PROJECT_DIR, filePath);
const content = readFileSync(abs, "utf-8");
return content.split("\n").length;
} catch { return 0; }
}

/** Get file size in bytes using Node.js fs. Returns 0 on error. */
function fileSize(filePath: string): number {
try {
const abs = join(PROJECT_DIR, filePath);
return statSync(abs).size;
} catch { return 0; }
}

/** Read tail bytes of a file. Returns empty string on error. */
function readTail(filePath: string, maxBytes: number): string {
try {
const stat = statSync(filePath);
const fd = openSync(filePath, "r");
const start = Math.max(0, stat.size - maxBytes);
const buf = Buffer.alloc(Math.min(maxBytes, stat.size));
readSync(fd, buf, 0, buf.length, start);
closeSync(fd);
return buf.toString("utf-8");
} catch { return ""; }
}

/**
Expand Down Expand Up @@ -39,8 +64,8 @@ export function registerTokenAudit(server: McpServer): void {
let wasteScore = 0;

// 1. Git diff size & dirty file count
const diffStat = run("git diff --stat --no-color 2>/dev/null");
const dirtyFiles = run("git diff --name-only 2>/dev/null");
const diffStat = run(["diff", "--stat", "--no-color"]);
const dirtyFiles = run(["diff", "--name-only"]);
const dirtyList = dirtyFiles.split("\n").filter(Boolean);
const dirtyCount = dirtyList.length;

Expand All @@ -62,9 +87,7 @@ export function registerTokenAudit(server: McpServer): void {
const largeFiles: string[] = [];

for (const f of dirtyList.slice(0, 30)) {
// Use shell-safe quoting instead of interpolation
const wc = run(`wc -l < '${shellEscape(f)}' 2>/dev/null`);
const lines = parseInt(wc) || 0;
const lines = countLines(f);
estimatedContextTokens += lines * AVG_LINE_BYTES * AVG_TOKENS_PER_BYTE;
if (lines > 500) {
largeFiles.push(`${f} (${lines} lines)`);
Expand All @@ -80,8 +103,7 @@ export function registerTokenAudit(server: McpServer): void {
// 3. CLAUDE.md bloat check
const claudeMd = readIfExists("CLAUDE.md", 1);
if (claudeMd !== null) {
const stat = run(`wc -c < '${shellEscape("CLAUDE.md")}' 2>/dev/null`);
const bytes = parseInt(stat) || 0;
const bytes = fileSize("CLAUDE.md");
if (bytes > 5120) {
patterns.push(`CLAUDE.md is ${(bytes / 1024).toFixed(1)}KB — injected every session, burns tokens on paste`);
recommendations.push("Trim CLAUDE.md to essentials (<5KB). Move reference docs to files read on-demand");
Expand Down Expand Up @@ -139,7 +161,7 @@ export function registerTokenAudit(server: McpServer): void {
// Read with size cap: take the tail if too large
const raw = stat.size <= MAX_TOOL_LOG_BYTES
? readFileSync(toolLogPath, "utf-8")
: run(`tail -c ${MAX_TOOL_LOG_BYTES} '${shellEscape(toolLogPath)}'`);
: readTail(toolLogPath, MAX_TOOL_LOG_BYTES);

const lines = raw.trim().split("\n").filter(Boolean);
totalToolCalls = lines.length;
Expand Down
Loading