Developer Reference

March 27, 2026 ยท View on GitHub

Auto-generated from project config files. Do not edit manually โ€” run npm run generate:dev-reference to regenerate.

  • Package: deft-mcp v1.0.0-beta.5
  • License: GPL-3.0-only
  • Node: >=22.0.0
  • Module System: module

Runtime Toolchain (mise)

Run mise install to set up all required runtimes.

ToolVersion
nodelts
bunlatest
denolatest
pnpmlatest

Entry Points

BinaryPath
deftdist/cli.js
deft-mcpdist/index.js

npm Scripts

ScriptCommandCategory
buildtsc๐Ÿ”จ Build
preversionnpm run typecheck && npm run lintโš™๏ธ Other
preparetsc && npm run generate:notices๐Ÿ”จ Build
postinstall`git config core.hooksPath .githooks
generate:noticestsx scripts/generate-notices.ts๐Ÿ“‹ CI/Gen
check:noticestsx scripts/generate-notices.ts --check๐Ÿ“‹ CI/Gen
generate:schematsx scripts/generate-schema.ts๐Ÿ“‹ CI/Gen
check:schematsx scripts/generate-schema.ts --check๐Ÿ“‹ CI/Gen
generate:dev-referencetsx scripts/generate-dev-reference.ts๐Ÿ“‹ CI/Gen
check:dev-referencetsx scripts/generate-dev-reference.ts --check๐Ÿ“‹ CI/Gen
sync:versiontsx scripts/sync-version.tsโš™๏ธ Other
generate:agent-docstsx scripts/generate-agent-docs.ts๐Ÿ“‹ CI/Gen
check:agent-docstsx scripts/generate-agent-docs.ts --check๐Ÿ“‹ CI/Gen
check:versiontsx scripts/sync-version.ts --check๐Ÿ“‹ CI/Gen
versionnpm run sync:version && npm run generate:agent-docs && npm run generate:dev-reference && npm run generate:schema && npm run generate:notices && git add README.md THIRD-PARTY-NOTICES.md docs/getting-started.md docs/client-setup.md docs/dev-reference.md docs/configuration.md docs/agents/ config.schema.json package-lock.jsonโš™๏ธ Other
devtsc --watch๐Ÿ”จ Build
testvitest run๐Ÿงช Test
test:watchvitest๐Ÿงช Test
test:coveragevitest run --coverage๐Ÿงช Test
lintoxlint && eslint src/ tests/๐Ÿงน Quality
lint:oxlintoxlint๐Ÿงน Quality
lint:eslinteslint src/ tests/๐Ÿงน Quality
fmtoxfmt๐Ÿงน Quality
fmt:checkoxfmt --check๐Ÿงน Quality
check:duplicationjscpd src/ tests/๐Ÿ“‹ CI/Gen
typechecktsc --noEmit๐Ÿ” Types

Deno Tasks

Requires unstable flags: sloppy-imports, node-globals

TaskCommand
deno task rundeno run -A src/index.ts
deno task clideno run -A src/cli.ts
deno task testdeno test -A tests/
deno task fmtdeno run -A npm:oxfmt
deno task fmt:checkdeno run -A npm:oxfmt --check
deno task lintdeno run -A npm:oxlint && deno run -A npm:eslint src/ tests/

mise Tasks

TaskDescriptionRuns
mise run devInstall deps and start dev modebun install && bun run dev
mise run checkRun all checks (fmt, typecheck, lint)bun run fmt:check && bun run typecheck && bun run lint
mise run ciFull CI pipeline locallybun run fmt:check && bun run typecheck && bun run lint && bun run check:duplication && bun run test:coverage

TypeScript

SettingValue
TargetES2022
ModuleNode16
Outputdist
Source Mapsโœ…
Declarationsโœ…
Strictโœ…

Testing (Vitest)

SettingValue
Globalstrue
Patterntests/**/*.test.ts
Coverage Providerv8
Thresholdslines: 80, functions: 80, branches: 75

Quality Toolchain

ToolRoleConfig
oxfmtFormatter.oxfmtrc.json
oxlintFast linter (TypeScript, correctness).oxlintrc.json
ESLintSpecialized linter (security, sonarjs)eslint.config.js
ESLint pluginssecurity, sonarjs, oxlint (dedup bridge), @typescript-eslint
jscpdDuplication detection.jscpd.json
tscType checkingtsconfig.json

Quick Reference

First-time setup

mise install        # Install runtimes (node, bun, deno, pnpm)
bun install         # Install dependencies

Common workflows

bun run fmt          # Format code
bun run typecheck    # Type check
bun run lint         # Lint (oxlint + eslint)
bun run test         # Run tests
bun run test:watch   # Watch mode
bun run test:coverage # With coverage
bun run build        # Compile to dist/

Shortcut tasks

mise run check    # fmt:check + typecheck + lint
mise run ci       # Full CI pipeline locally

Deno alternative

deno task run     # Start MCP server
deno task cli     # Run CLI
deno task lint    # Lint

Dependencies

Runtime

PackageVersion
@modelcontextprotocol/sdk^1.27.1
ajv^8.18.0
better-sqlite3^12.8.0
yaml^2.8.2

Development

PackageVersion
@types/better-sqlite3^7.6.13
@types/node^25.5.0
@typescript-eslint/eslint-plugin^8.57.0
@typescript-eslint/parser^8.57.0
@vitest/coverage-v8^4.1.0
eslint^10.0.3
eslint-plugin-oxlint^1.57.0
eslint-plugin-security^4.0.0
eslint-plugin-sonarjs^4.0.2
jscpd^4.0.8
license-checker^25.0.1
oxfmt^0.42.0
oxlint^1.57.0
ts-json-schema-generator^2.4.0
tsx^4.21.0
typescript^5.9.3
vitest^4.1.0