# AGENTS.md
MCP Server that enables LLMs to interact with the local filesystem. Provides tools for navigation, search, file management, and analysis ÔÇö all scoped to allowed directories.
## Tooling
- **Manager**: npm
- **Frameworks**: typescript, eslint, @modelcontextprotocol/sdk, @trivago/prettier-plugin-sort-imports, commander, eslint-config-prettier, eslint-plugin-de-morgan, eslint-plugin-depend
## Commands
- **Dev**: `npm run dev`
- **Test**: `npm run test`
- **Lint**: `npm run lint`
- **Deploy**: `npm run prepublishOnly`
## Safety Boundaries
- **Always**: `npm run lint`, `npm run type-check`, `npm run test`
- **Ask First**: `installing dependencies`, `deleting files`, `running full builds or e2e suites`, `database/schema migrations`, `deploy or infrastructure changes`, `git push / force push`, `npm run build`, `npm run prepublishOnly`, `git push origin main --follow-tags`, `gh release create "v$VERSION" --title "v$VERSION" --generate-notes`, `npm publish --access public --provenance --ignore-scripts`
- **Never**: commit or expose secrets/credentials (including `.mcpregistry_github_token`, `.mcpregistry_registry_token`); edit generated/vendor directories (`.git`, `.tmp`, `dist`, `node_modules`); commit or expose secrets/credentials; edit vendor/generated directories; change production config without approval
## Directory Overview
```text
.
├── .github/ # CI/workflows and repo automation
├── .vscode/
├── assets/ # static assets
├── memory_db/
├── node-tests/ # test suites
├── scripts/ # automation scripts
├── src/ # application source
├── .prettierignore # formatter config
├── .prettierrc # formatter config
├── docker-compose.yml # local container orchestration
├── Dockerfile # container image build
├── eslint.config.mjs # lint config
├── package.json # scripts and dependencies
├── README.md # usage and setup docs
├── server.json # published server metadata
└── tsconfig.build.json # TypeScript config
└── ... # 2 more top-level items omitted
```
## Navigation
- **Entry Points**: `package.json`, `README.md`, `src/index.ts`, `src/server.ts`, `docker-compose.yml`
- **Key Configs**: `ESLint`, `Git`, `Prettier`, `TypeScript`
## Don'ts
- Don't bypass existing lint/type rules without approval.
- Don't ignore test failures in CI.
- Don't use unapproved third-party packages without checking package manager manifests.
- Don't hardcode secrets or sensitive info in code, tests, docs, or config.
- Don't commit or share `.mcpregistry_github_token`, `.mcpregistry_registry_token`.
- Don't edit generated/vendor directories such as `.git`, `.tmp`, `dist`.
- Don't run release/publish/tag/push automation without explicit approval.
## Change Checklist
1. Run `npm run lint`.
2. Run `npm run type-check`.
3. Run `npm run test`.
4. Run `npm run build` when runtime/server behavior changes.
5. Update `README.md` when public behavior or usage changes.
6. Update `server.json` when published metadata/version behavior changes.
